diff --git a/README-dev.md b/README-dev.md new file mode 100644 index 0000000000000000000000000000000000000000..24cafcfa52a371c0551680ff7d28bcf294e5f1ae --- /dev/null +++ b/README-dev.md @@ -0,0 +1,45 @@ +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 diff --git a/README.md b/README.md index e6fa51cfbf2a0912336b1c3d6e0950979460b4ac..ea7ab869fb393ead05e437f04d5aecaef9d7c794 100644 --- a/README.md +++ b/README.md @@ -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