Commit e684c5b1 authored by PRUVOST Florent's avatar PRUVOST Florent

initiate a README-dev.md where we could define rules for developers

parent bad63cc6
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
---------------------
TODO - Right here how to use git and gitlab to push modifications into
Chameleon.
### Update submodules
Chameleon git project depends on a "submodule" git, located in
cmake_modules/morse_cmake and hosted here
https://gitlab.inria.fr/solverstack/morse_cmake.
To update this submodule to the last development state, follow these
steps:
```
#!shell
git submodule update --remote cmake_modules/morse_cmake
git commit cmake_modules/morse_cmake -m "update morse_cmake submodule"
git push --recurse-submodules=check
```
Documentation
---------------------
TODO - Right here how to generate the documentation.
Packaging
---------------------
TODO - Right here the steps to create a new release:
- what needs to be checked (ctest, docummentation, version, ...)
- how to generate the package .tar.gz
- what and where to publish externally
Naming and writting conventions
---------------------
TODO - Right here the rules and conventions used in the source code.
\ No newline at end of file
......@@ -26,7 +26,7 @@ Get Chameleon
---------------------
To use last development states of Chameleon, please clone the master
branch. Note that Chameleon contains a `git submodule` **morse_cmake**.
branch. Note that Chameleon contains a `git submodule` **morse_cmake**.
To get sources please use these commands:
# if git version >= 1.9
......
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