diff --git a/README-dev.org b/README-dev.org index 54cd3c7068b15bb73120969d1dfbf58238011556..cdaefe4fe096473bff0a9c6ccea9004e9ac943d8 100644 --- a/README-dev.org +++ b/README-dev.org @@ -8,7 +8,7 @@ developers must follow and that should be read by contributors. * Gitlab flow: how to contribute to Chameleon - Please read and follow guidelines given in the [[https://gitlab.inria.fr/solverstack/chameleon/blob/master/CONTRIBUTING.md][CONTRIBUTING file]]. + Please read and follow guidelines given in the [[file:CONTRIBUTING.org][CONTRIBUTING file]]. ** Update submodules @@ -54,11 +54,12 @@ developers must follow and that should be read by contributors. ** Rules about source code documentation - TODO - Write here the rules to document source code inside chameleon. + Please refer to this file for the documentation guidelines [[file:docs/doxygen/README.org][README]]. * Naming and writting conventions - TODO - Write here the rules and conventions used in the source code. + Chameleon library started as an extension of the PLASMA library so + that code naming and writting conventions should follow [[https://bitbucket.org/icl/plasma][PLASMA]] ones. * Packaging diff --git a/README.org b/README.org index b21fd10c064d124376dcf503e2c4d762b0ae7571..7813b53e5dd92f5cca478529695cb4b743f64a47 100644 --- a/README.org +++ b/README.org @@ -52,14 +52,6 @@ dedicated to dense linear algebra. * Installation -** Build and install with CMake - - Chameleon can be built using [[https://cmake.org/][CMake]]. This installation requires to - have some library dependencies already installed on the system. - - Please refer to the [[http://morse.gforge.inria.fr/chameleon/0.9.1/chameleon_users_guide-0.9.1.html#Installing-CHAMELEON][chameleon-0.9.1]] to get configuration - information. - ** Distribution of Chameleon To get support to install a full distribution (Chameleon + @@ -67,19 +59,36 @@ dedicated to dense linear algebra. Please read these documentations: - * [[http://morse.gforge.inria.fr/spack/spack.html][Spack Morse]]. - * [[http://morse.gforge.inria.fr/spack/spack.html#sec-2-1][Section Chameleon]]. + * [[http://morse.gforge.inria.fr/spack/spack.html][Spack Morse]] + * [[http://morse.gforge.inria.fr/spack/spack.html#sec-2-1][Section Chameleon]] + +*** Usage example for a simple distribution of Chameleon + + #+begin_src sh + git clone https://github.com/solverstack/spack.git + . ./spack/share/spack/setup-env.sh + spack install -v chameleon + # chameleon is installed here: + `spack location -i chameleon` + #+end_src + +** Build and install with CMake + + Chameleon can be built using [[https://cmake.org/][CMake]]. This installation requires to + have some library dependencies already installed on the system. + + Please refer to [[http://morse.gforge.inria.fr/chameleon/0.9.1/chameleon_users_guide-0.9.1.html#Installing-CHAMELEON][chameleon-0.9.1]] to get configuration information. * Get involved! ** Mailing list - To contact the developers send an email at + To contact the developers send an email to [[mailto:morse-devel@lists.gforge.inria.fr][morse-devel@lists.gforge.inria.fr]] ** Contributions - https://gitlab.inria.fr/solverstack/chameleon/blob/master/CONTRIBUTING.md + [[file:CONTRIBUTING.org][CONTRIBUTING]] * Authors @@ -110,4 +119,4 @@ dedicated to dense linear algebra. * Licence - https://gitlab.inria.fr/solverstack/chameleon/blob/master/LICENCE.txt + [[file:LICENCE.txt][LICENCE]]