X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=README;h=82f7521a44a8e958a59a2d3c75d0068b83770442;hb=221459de0ddb631228845bb33a59031985fcf94f;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=f88323a3118ea63d7117f75d4d90ba5cb9268d7b;p=samples%2Fpycalculator.git

diff --git a/README b/README
index e69de29..82f7521 100644
--- a/README
+++ b/README
@@ -0,0 +1,100 @@
+********************************
+About SALOME PYCALCULATOR sample
+********************************
+
+PYCALCULATOR module implements a sample of Python-based SALOME component.
+It shows an example of a module that interfaces with SALOME MED.
+
+For more information please visit the SALOME platform 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 PYCALCULATOR needs SALOME KERNEL and SALOME MED modules 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 PYCALCULATOR_BUILD
+
+3. Configure the build procedure:
+
+   % cd PYCALCULATOR_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 PYCALCULATOR
+     module (default: /usr); 
+   - <path_to_src_dir> is a path to the SALOME PYCALCULATOR sources directory.
+
+   Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME PYCALCULATOR
+   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 PYCALCULATOR module to the <installation_directory>
+   specified to cmake command on the previous step.
+
+-------------------
+Custom installation
+-------------------
+
+SALOME PYCALCULATOR 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.