Salome HOME
add warning on environment
authorNicolas CROUZET - SFME/LGLS <crouzet@is228840.intra.cea.fr>
Tue, 10 Nov 2020 07:21:43 +0000 (08:21 +0100)
committerNicolas CROUZET - SFME/LGLS <crouzet@is228840.intra.cea.fr>
Tue, 10 Nov 2020 07:21:43 +0000 (08:21 +0100)
doc/src/index.rst

index ff216d0061b35dc8f961d126c8dc703c61a7ce9e..85c71376c09d64963f8af2f000a9ddc97ece5061 100644 (file)
@@ -29,9 +29,11 @@ The following features should be highlighted:
  * **packaging**: creation of binary and/or source packages to distribute the application on various platforms
  * **overwriting** the configuration in command line: it allows users setting easily their own preferences or options
  
-SAT uses **python**, and many of its strength come from its power and straightforwardness.
+SAT uses **python**, and many of its strength come from its power and straightforwardness. It is compatible with both python2 and python3 versions.
 SAT is a Command Line Interface (CLI_) based on python langage. It is a suite of commands, which are detailed later in this documentation.
-These commands are used to perform the operations on the application.
+These commands are used to perform the operations on the application. SAT enables command completion by sourcing the provided complete_sat.sh script.
+
+Like similar tool, SAT doesn't like modified environments, as this can cause conflicts while compiling products or using applications. It is recommended that SAT users run with a **clean environment**, especially for PATH, LD_LIBRARY_PATH and PYTHONPATH. ~/.bashrc file should be as thin as possible!
 
 
 Documentation