]> SALOME platform Git repositories - tools/solverlab.git/commitdiff
Salome HOME
Updated the documentation
authorNDJINGA Michael <ndjinga@is224593.intra.cea.fr>
Tue, 18 Jan 2022 15:36:51 +0000 (16:36 +0100)
committerNDJINGA Michael <ndjinga@is224593.intra.cea.fr>
Tue, 18 Jan 2022 15:36:51 +0000 (16:36 +0100)
README.md

index b89880fcfc374878ae2651b80490423d92922d7c..d9eaa9c5804fff7379ba45e37b925c5e19671974 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -66,7 +66,7 @@ Dependencies. The following package list is sufficient on Ubuntu 20.04 :
  - `pyqt5-dev-tools` to generate the Graphical User Interface (optional)
  - `python3-matplotlib`, `paraview-dev`, `libnetcdf-dev` (on Ubuntu 20.04) and `python3-paraview` for postprocessing tools such as plotting curves (matplotlib) or generating 3D view images (paraview) (optional)
  - `ffmpeg` and `ffmpeg-devel` to generate an animation from a set of curves (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).
+ - `python3-sphinx` for the GUI documentation, and `doxygen`, `graphviz` and `mscgen` to generate a developper documentation. 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).