Commit cda8fcf9 authored by Enrique Garcia's avatar Enrique Garcia
Browse files

add to README how to install the library, and some links and examples

parent 1b983764
......@@ -9,11 +9,15 @@ It shows the **basic documentation** a project should include, following the [op
* An [open source](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository#where-does-the-license-live-on-my-repository) **license**.
* A [**README** file](https://help.github.com/en/github/getting-started-with-github/create-a-repo#commit-your-first-change), similar to this one.
* Contributing guidelines (see below).
* A code of conduct (TBD).
* Contributing guidelines.
- See below the general guidelines for the ESCAPE repository.
* A [code of conduct](https://opensource.guide/code-of-conduct/).
- Check why is a good idea to add one.
* The structure of the repository.
* It would be highly suitable to include too:
- A setup file to install the library.
- A setup file as well as the basic commands to install the library (see below).
- A .gitignore file.
- Unitary and integration tests.
......@@ -21,7 +25,7 @@ It shows the **basic documentation** a project should include, following the [op
Take few minutes to check the [ESCAPE repository's guidelines](https://gitlab.in2p3.fr/escape2020/guidelines) too.
# Contributing guidelines
# 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.
......@@ -35,8 +39,20 @@ Once you are granted with developer access, you will be able to add a new blank
- ***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.
# Installation
```sh
$ git clone https://gitlab.in2p3.fr/escape2020/escape/template_project_escape.git
$ cd template_project_escape
$ python setup.py install
```
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 ! (ESCAPE DOI will be available soon !)
Please do not forget to cite the ESCAPE repository !
<p align="center">ESCAPE DOI will be available soon !</p>
# Report an issue / Ask a question
Use [GitLab Issues](https://gitlab.in2p3.fr/groups/escape2020/-/issues).
......
......@@ -3,13 +3,13 @@ import template_escape
setuptools.setup(name='template_project_escape',
version=template_escape.__version__,
description="DESCRIPTION", # these should be minimum list of what is needed to run
description="Template project for the ESCAPE repository",
packages=setuptools.find_packages(),
install_requires=['numpy'],
package_data={'template_project_escape': ['./template_project_escape/*']},
tests_require=['pytest'],
author='See Guidelines',
author_email='See Guidelines',
license='See LICENSE file',
url='https://gitlab.in2p3.fr/escape2020'
author='https://github.com/garciagenrique',
author_email='garcia<at>lapp.in2p3.fr',
license='Open Source. MIT license. See LICENSE file.',
url='https://gitlab.in2p3.fr/escape2020/escape/template_project_escape'
)
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