Commit 180bc4fc authored by Enrique Garcia's avatar Enrique Garcia
Browse files

add DOI to readme

parent 64230941
# template_project_escape
# template_project_escape [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3572655.svg)](https://doi.org/10.5281/zenodo.3572655)
<p align="center">
<img src="https://cdn.eso.org/images/large/ann18084a.jpg" width="640" height="453"/>
</p>
......@@ -26,17 +28,23 @@ Take few minutes to check the [ESCAPE repository's guidelines](https://gitlab.in
# Contributing guidelines for the ESCAPE repository
If you wish to provide software to the ESCAPE repository, you should ask developer access through the Gitlab interface and send an email to vuillaume [at] lapp.in2p3.fr with your institution email.
If you wish to provide software to the ESCAPE repository:
- You should ask developer access through the Gitlab interface and send an email to vuillaume [at] lapp.in2p3.fr with your institution email.
You will then be able to open a new project and transfer code.
- You will then be able to open a new project and transfer code.
All the code provided should be uploaded from the [zenodo ESCAPE community](https://zenodo.org/communities/escape2020/).
- All the code provided should be uploaded from the [zenodo ESCAPE community](https://zenodo.org/communities/escape2020/).
For a detailed explanation of how to submit a contribution to a project / repository (Fork, create a branch, make a pull request...), please check the [opensource guide](https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution) and/or the [git's documentation](https://git-scm.com/doc).
- For a detailed explanation of how to submit a contribution to a project / repository (Fork, create a branch, make a pull request...), please check the [opensource guide](https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution) and/or the [git's documentation](https://git-scm.com/doc).
Once you are granted with developer access, you will be able to add a new blank project / import it (from other common repository managers, i.e., GitHub, GitLab, Bitbucket, Fogbugz...) to the [GitLab/ESCAPE](https://gitlab.in2p3.fr/escape2020) main page.
- Once you are granted with developer access, you will be able to add a new blank project / import it (from other common repository managers, i.e., GitHub, GitLab, Bitbucket, Fogbugz...) to the [GitLab/ESCAPE](https://gitlab.in2p3.fr/escape2020) main page.
- ***PLEASE NOTE*** that if you have login GitLab by using the `[Shibbolenth]` service (eduGAIN, Fédération d'Identités RENATER), you will need to [add a SSH key](https://gitlab.in2p3.fr/help/ssh/README#generating-a-new-ssh-key-pair) to your GitLab profile if you want to 'push' your changes to the server.
***PLEASE NOTE*** that if you have login GitLab by using the `[Shibbolenth]` service (eduGAIN, Fédération d'Identités RENATER), you will need to [add a SSH key](https://gitlab.in2p3.fr/help/ssh/README#generating-a-new-ssh-key-pair) to your GitLab profile if you want to 'push' your changes to the server.
### Docker / containers
Documentation of how to create a Docker image / container of your code and add it to the ESCAPE repository and community is under construction.
# Installation
......@@ -50,8 +58,11 @@ This is an easy method to install the library.
You can also check other more elaborated ways - generally for bigger repositories - here (e.g., [cta-observatory/cta-lstchain](https://github.com/cta-observatory/cta-lstchain), [cta-observatory/ctapipe](https://github.com/cta-observatory/ctapipe)).
# Citing
Please do not forget to cite the ESCAPE repository !
<p align="center">ESCAPE DOI will be available soon !</p>
In case of citing this repository, use the following DOI:
- v 1.0: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3572655.svg)](https://doi.org/10.5281/zenodo.3572655)
Do not forget to include the code in the [zenodo ESCAPE community](https://zenodo.org/communities/escape2020/).
- ***Note that*** you will be able to assign a DOI in the moment you include your code/repository to zenodo.
# Report an issue / Ask a question
Use [GitLab Issues](https://gitlab.in2p3.fr/groups/escape2020/-/issues).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment