From 631933104e4f519f60bf2a362fc2bd9ffc0add1f Mon Sep 17 00:00:00 2001 From: Nicolas CROUZET - SFME/LGLS Date: Tue, 10 Nov 2020 08:21:43 +0100 Subject: [PATCH] add warning on environment --- doc/src/index.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/src/index.rst b/doc/src/index.rst index ff216d0..85c7137 100644 --- a/doc/src/index.rst +++ b/doc/src/index.rst @@ -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 -- 2.39.2