]> SALOME platform Git repositories - tools/solverlab.git/commitdiff
Salome HOME
Replaced github.com by git.salome-platform.com
authorndjinga <michael.ndjinga@cea.fr>
Wed, 23 Sep 2020 11:35:09 +0000 (13:35 +0200)
committerndjinga <michael.ndjinga@cea.fr>
Wed, 23 Sep 2020 11:35:09 +0000 (13:35 +0200)
README.md

index b37e48542ac68a528e6a76a158bed8f6dab7fd1b..1cd1f0ced79d60f95e045b36c5bd8fc03210bb80 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -40,10 +40,8 @@ Create your source directory. For instance:
 * `mkdir ~/workspace/SOLVERLAB`
 * `cd ~/workspace/SOLVERLAB`
 
-Download from GitHub
-* click on the following link : `https://github.com/ndjinga/SOLVERLAB/archive/master.zip`, then unzip the file in a directory SOLVERLAB-master
-* or type the following in a terminal : `wget https://github.com/ndjinga/SOLVERLAB/archive/master.zip`, then unzip the file in a directory SOLVERLAB-master
-* or clone the git repository to a folder SOLVERLAB-master:  `git clone https://github.com/ndjinga/SOLVERLAB.git SOLVERLAB-master`
+Download from salome-platform.org
+* clone the git repository to a folder SOLVERLAB-master:  `git clone http://git.salome-platform.org/gitpub/modules/SolverLab.git SOLVERLAB-master`
 
 
 Set the environment for the compilation of SOLVERLAB
@@ -54,7 +52,7 @@ Dependencies. The following package list is sufficient on Ubuntu 14.04, Ubuntu 1
  - `g++` or another C++ compiler (mandatory)
  - `python-dev`, `python-numpy` and `swig3`for python scripts (mandatory)
  - `python-matplotlib` and `paraview` for postprocessing tools such as plotting curves (matplotlib) or generating 3D view images (paraview) (mandatory)
- - `doxygen`, `graphviz` and `mscgen`, if you want to generate a nice source code documentation in `~/workspace/SOLVERLAB/SOLVERLAB_install/doc/`. Use the compilation option `-DSOLVERLAB_WITH_DOCUMENTATION=ON` (optional).
+ - `doxygen`, `graphviz` and `mscgen`, if you want to generate a nice source code documentation in `~/workspace/SOLVERLAB/SOLVERLAB_install/share/doc/`. Use the compilation option `-DSOLVERLAB_WITH_DOCUMENTATION=ON` (optional).
  - `libcppunit-dev`, if you want to generate unit tests. Use the compilation option `-DSOLVERLAB_WITH_TESTS=ON` (optional).
  - `rpm`, if you want to generate RPM installation packages. Use the compilation option `-DSOLVERLAB_WITH_PACKAGE=ON` (optional).
 
@@ -89,7 +87,7 @@ The 3 dependencies PETSC, MED and MEDCOUPLING should have been compiled with the
 Warning : the linux package libhdf5-dev is generally not compatible with the libraries MED and MEDCoupling  
 Compile and install:
 * `make`
-* `make doc install`
+* `make install`
 
 Run unit and example tests:
 * make example
@@ -97,6 +95,12 @@ Run unit and example tests:
 Run validation tests:
 * make validation
 
+Generate documentation of CDMATH module
+* make docCDMATH
+
+Generate documentation of CoreFlows module
+* make docCoreFlows
+
 Use of SOLVERLAB
 -------------