X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=README;h=8236701ad99647cd9000b88aa254293ea3afdfda;hb=refs%2Fheads%2FV9_7_BR;hp=2b3640199858344501d20c735a916c6439204d60;hpb=3a6f758c36d33def8d14527f8f05c80758e672b6;p=plugins%2Fblsurfplugin.git

diff --git a/README b/README
index 2b36401..8236701 100644
--- a/README
+++ b/README
@@ -1,108 +1,125 @@
-SALOME platform
-BLSURF meshing plugin
-------------------------------
+*******************************
+About SALOME MG-CADSurf plug-in
+*******************************
 
-Contents:
+SALOME MG-CADSurf plug-in adds DISTENE MG-CADSurf (former BLSURF) meshing algorithm
+to the SALOME Mesh module.
 
-1. Pre-requisites
-2. Installation
-3. Launch SALOME with BLSURFPLUGIN
-4. BLSURFPLUGIN plugin usage
+MG-CADSurf meshing algorithm is destined for generation of 2D meshes basing
+on the 2D geometric entities (faces).
 
------------------
-1. Pre-requisites
------------------
+For more information please visit the SALOME platform web site:
 
-The information in this file assumes that:
+  <http://www.salome-platform.org/>
 
-* The SALOME platform is installed to the directory <salome>
-* The blsurf product is installed to the directory <salome>/blsurf
-* The decimesh binary is vaiable via environment variable PATH
+=======
+License
+=======
 
----------------
-2. Installation
----------------
+SALOME platform is distributed under the GNU Lesser General Public License.
+See COPYING file for more details.
 
-2.1. Unpack BLSURFPLUGIN module sources
+Also, additional information can be found at SALOME platform web site:
 
-cd <salome>
-tar zxf BLSURFPLUGIN_SRC.tgz
+  <http://www.salome-platform.org/downloads/license/>
 
-2.2. Build BLSURFPLUGIN module
+============
+Installation
+============
 
-* set environment 
+--------------
+Pre-requisites
+--------------
 
-bash
-cd <salome>
-source env_build.sh
+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.
 
-* cmake build procedure
+For more information about the pre-requisites please visit SALOME platform web
+site:
 
-mkdir BLSURFPLUGIN_BUILD
-cd BLSURFPLUGIN_BUILD
-cmake -DCMAKE_BUILD_TYPE=<Mode> -DCMAKE_INSTALL_PREFIX=<BLSURFPLUGIN_INSTALL> ../BLSURFPLUGIN_SRC
+* Check Release Notes and Software Requirements of the latest SALOME release at
 
-,where <Mode> is build mode (Release or Debug), 
-<BLSURFPLUGIN_INSTALL> is a destination folder to install 
-BLSURFPLUGIN module of SALOME.
+  <http://www.salome-platform.org/downloads/current-version/>
 
-Verify that all pre-requisites required for the successful compilation
-of BLSURFPLUFIN module have been found.
+* Pre-requisites page at SALOME web site:
 
-* compile and install plugin module 
+  <http://www.salome-platform.org/downloads/license/>
 
-make
-make install
+Note: SALOME MG-CADSurf plug-in needs SALOME KERNEL, SALOME GUI, SALOME Geometry
+and SALOME Mesh as pre-requisites.
 
-exit
+------------------
+Basic Installation
+------------------
 
-If the compilation is finished successfully (make and make install
-steps are finished without errors) the BLSURFPLUGIN meshing module
-should be installed in the directory <BLSURFPLUGIN_INSTALL>.
+The build procedure of the SALOME platform is implemented with CMake.
+In order to build the plug-in you have to do the following actions: 
 
-----------------------------------
-3. Launch SALOME with BLSURFPLUGIN
-----------------------------------
+1. Set up environment for pre-requisites (see "Pre-requisites" section above).
 
-* set environment
+2. Create a build directory:
 
-bash
-cd <salome>
-source env_products.sh
+   % mkdir BLSURFPLUGIN_BUILD
 
-export BLSURFPLUGIN_ROOT_DIR=<BLSURFPLUGIN_INSTALL>
-export SalomeAppConfig=${BLSURFPLUGIN_ROOT_DIR}/share/salome/resources/blsurfplugin
-export DISTENE_LICENSE_FILE=<salome>/dlim8.key
+3. Configure the build procedure:
 
-Note: DISTENE_LICENSE_FILE environment variable should point to the
-blsurf product license file.
+   % cd BLSURFPLUGIN_BUILD
+   % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
 
-* run SALOME
+   where
+   - <mode> is either Release or Debug (default: Release);
+   - <installation_directory> is a destination folder to install SALOME MG-CADSurf
+     plug-in (default: /usr); 
+   - <path_to_src_dir> is a path to the SALOME MG-CADSurf plug-in sources directory.
 
-runSalome
+   Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME MG-CADSurf
+   plug-in will be configured for installation to the /usr directory that requires
+   root permissions to complete the installation.
 
-----------------------------
-4. BLSURFPLUGIN plugin usage
-----------------------------
+4. Build and install:
 
-* Create new study
+   % make
+   % make install
 
-* Activate Geometry module and create simple geometry object
+   This will install SALOME MG-CADSurf plug-in to the <installation_directory>
+   specified to cmake command on the previous step.
 
-* Activate Mesh module
+-------------------
+Custom installation
+-------------------
 
-* Invoke menu "Mesh/Create Mesh"
+SALOME MG-CADSurf plug-in 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
+
+=====
+Usage
+=====
+
+* Start SALOME.
+
+* Create new study.
+
+* Activate Geometry module and create simple geometry object.
+
+* Activate Mesh module.
+
+* Invoke menu "Mesh/Create Mesh".
 
 * Select previously created geometry object by clicking it with the
-mouse in the Object Browser
+  mouse in the Object Browser.
 
 * In the "Create mesh" dialog box:
-- activate "2D" page
-- In the "Algorithm" combo box select "BLSURF"
-- Click on the button at the right of the "Hypothesis" combo box and
-select "BLSURF parameters" item in the drop-down menu
+  - activate "2D" page;
+  - In the "Algorithm" combo box select "MG-CADSurf";
+  - Click on the button at the right of the "Hypothesis" combo box and
+    select "MG-CADSurf parameters" item in the drop-down menu.
 
-* In the "Hypothesis Construction" dialog box set parameters of BLSURF
+* In the "Hypothesis Construction" dialog box set parameters of MG-CADSurf
   meshing algorithm and click "OK" button
 
 * In the "Create mesh" dialog box Click "Apply & Close" button to
@@ -111,5 +128,18 @@ select "BLSURF parameters" item in the drop-down menu
 * In the Object Browser select "Mesh_1" object, invoke context popup
 menu for it by clicking right mouse button and select "Compute" item
 
-The resulting mesh created with BLSURF plugin will be shown in the 3D
+The resulting mesh created with MG-CADSurf plugin will be shown in the 3D
 viewer.
+
+=============
+Documentation
+=============
+
+The directory doc contains additional documentation file of SALOME MG-CADSurf
+plug-in.
+
+===============
+Troubleshooting
+===============
+
+Please, send a mail to webmaster.salome@opencascade.com.