X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=README;h=8d4362009963ef4aa2ed979222ec0a90dd4791cc;hb=refs%2Fheads%2FV9_2_1_BR;hp=ffdc95eb778498f051e002c92f6e29967ea91a4d;hpb=8e5ad7e7bb8f9c578ce473e38b0d41fdc6b308b7;p=samples%2Fpyhello.git

diff --git a/README b/README
old mode 100755
new mode 100644
index ffdc95e..8d43620
--- a/README
+++ b/README
@@ -1,11 +1,100 @@
-This module is a Salome example of a module implemented in Python with PyQt GUI
+***************************
+About SALOME PYHELLO sample
+***************************
 
-Installation and compilation is like every Salome modules :
- mkdir build_dir 
- mkdir instal_dir
- cd build_dir
- cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=instal_dir ../src_dir
- make
- make install
+SALOME PYHELLO module presents example of a simple SALOME module, implemented
+with Python. This sample demonstrates a way to create a modules which provide
+services via the CORBA engine.
 
-Documentation can be found in /doc directory.
+For more information about SALOME platform please visit the SALOME web site:
+
+  <http://www.salome-platform.org/>
+
+=======
+License
+=======
+
+SALOME platform is distributed under the GNU Lesser General Public License.
+See COPYING file for more details.
+
+Also, additional information can be found at SALOME platform web site:
+
+  <http://www.salome-platform.org/downloads/license/>
+
+============
+Installation
+============
+
+--------------
+Pre-requisites
+--------------
+
+SALOME platform relies on a set of third-party softwares; some of them are needed
+at build time only, while other ones are needed in runtime also.
+
+For more information about the pre-requisites please visit SALOME platform web
+site:
+
+* Check Release Notes and Software Requirements of the latest SALOME release at
+
+  <http://www.salome-platform.org/downloads/current-version/>
+
+* Pre-requisites page at SALOME web site:
+
+  <http://www.salome-platform.org/downloads/license/>
+
+Note: SALOME PYHELLO needs SALOME KERNEL and SALOME GUI as pre-requisites.
+
+------------------
+Basic Installation
+------------------
+
+The build procedure of the SALOME platform is implemented with CMake.
+In order to build the module you have to do the following actions:
+
+1. Set up environment for pre-requisites (see "Pre-requisites" section above).
+
+2. Create a build directory:
+
+   % mkdir PYHELLO_BUILD
+
+3. Configure the build procedure:
+
+   % cd PYHELLO_BUILD
+   % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
+
+   where
+   - <mode> is either Release or Debug (default: Release);
+   - <installation_directory> is a destination folder to install SALOME PYHELLO
+     module (default: /usr);
+   - <path_to_src_dir> is a path to the SALOME PYHELLO sources directory.
+
+   Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME PYHELLO
+   module will be configured for installation to the /usr directory that requires
+   root permissions to complete the installation.
+
+4. Build and install:
+
+   % make
+   % make install
+
+   This will install SALOME PYHELLO module to the <installation_directory>
+   specified to cmake command on the previous step.
+
+-------------------
+Custom installation
+-------------------
+
+SALOME PYHELLO module supports a set of advanced configuration options;
+for more details learn CMakeLists.txt file in the root source directory.
+
+You can also use other options of cmake command to customize your installation.
+Learn more about available options by typing
+
+   % cmake --help
+
+===============
+Troubleshooting
+===============
+
+Please, send a mail to webmaster.salome@opencascade.com.