Mentions légales du service

Skip to content
Snippets Groups Projects
Commit 1d472c5c authored by PRUVOST Florent's avatar PRUVOST Florent
Browse files

add link to contributing.md and update section documentation

parent 57505b18
No related branches found
No related tags found
No related merge requests found
......@@ -4,11 +4,11 @@ README for developers
This page is dedicated to rules and conventions that Chameleon's
developers must follow and that should be read by contributors.
Gitlab flow
Gitlab flow: how to contribute to Chameleon
---------------------
TODO - Write here how to use git and gitlab to push modifications into
Chameleon.
Please read and follow guidelines given here:
https://gitlab.inria.fr/solverstack/chameleon/blob/master/CONTRIBUTING.md
### Update submodules
......@@ -29,7 +29,38 @@ git push --recurse-submodules=check
Documentation
---------------------
TODO - Write here how to generate the documentation.
### Generate the documentation
#### Prerequisites
To generate the documentation you need to have
[Doxygen](http://www.stack.nl/~dimitri/doxygen/) and
[Texinfo](https://www.gnu.org/software/texinfo/) installed on your
system.
For example, on Debian systems:
```
#!shell
sudo apt install doxygen texinfo
```
#### configure + make documentation
Enter into the Chameleon's source root directory and configure with
*CHAMELEON_ENABLE_DOCS=ON*, then generate the documentation with `make
docs`
```
#!shell
cd chameleon
mkdir build && cd build
cmake .. -DCHAMELEON_ENABLE_DOCS=ON
make docs
```
### Rules about source code documentation
TODO - Write here the rules to document source code inside chameleon.
Packaging
---------------------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment