diff --git a/README-dev.md b/README-dev.md index d424ed37dbf407bc5ae9ae3ba2943c542d88b434..c8304113622694037133234a99c6ab0c9d6d84f5 100644 --- a/README-dev.md +++ b/README-dev.md @@ -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 ---------------------