X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=README;h=9c67003bece0aed739c6e17adf601d55bf70d61e;hb=f5ee0b2342d56a1d952f013c4591a6362b6346da;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=242cc45f11d244ee0129ec93b9d116df97c81cb7;p=plugins%2Fghs3dplugin.git

diff --git a/README b/README
index e69de29..9c67003 100644
--- a/README
+++ b/README
@@ -0,0 +1,113 @@
+*****************************
+About SALOME MG-Tetra plug-in
+*****************************
+
+SALOME MG-Tetra plug-in adds DISTENE MG-Tetra (former GHS3D) meshing algorithm
+to the SALOME Mesh module.
+
+MG-Tetra meshing algorithm is destined for:
+- Meshing of 3D geometric entities: solids are split into tetrahedral (pyramidal)
+  elements;
+- Generating of 3D meshes from 2D meshes (triangles and quadrangles), working without
+  geometrical objects.
+
+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 MG-Tetra plug-in needs SALOME KERNEL, SALOME GUI, SALOME Geometry
+and SALOME Mesh as pre-requisites.
+
+------------------
+Basic Installation
+------------------
+
+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: 
+
+1. Set up environment for pre-requisites (see "Pre-requisites" section above).
+
+2. Create a build directory:
+
+   % mkdir GHS3DPLUGIN_BUILD
+
+3. Configure the build procedure:
+
+   % cd GHS3DPLUGIN_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 MG-Tetra
+     plug-in (default: /usr); 
+   - <path_to_src_dir> is a path to the SALOME MG-Tetra plug-in sources directory.
+
+   Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME MG-Tetra
+   plug-in 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 MG-Tetra plug-in to the <installation_directory>
+   specified to cmake command on the previous step.
+
+-------------------
+Custom installation
+-------------------
+
+SALOME MG-Tetra 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
+
+=============
+Documentation
+=============
+
+The directory doc contains additional documentation file of SALOME MG-Tetra
+plug-in.
+
+===============
+Troubleshooting
+===============
+
+Please, send a mail to webmaster.salome@opencascade.com.