Salome HOME
[EDF22802] : Rosette filter improvement
[tools/paravisaddons_common.git] / README
1 **************************
2 About SALOME PARAVISADDONS
3 **************************
4
5 =======
6 License
7 =======
8
9
10 ============
11 Installation
12 ============
13
14 --------------
15 Pre-requisites
16 --------------
17
18 ------------------
19 Basic Installation
20 ------------------
21
22 The build procedure of the SALOME platform is implemented with CMake.
23 In order to build the module you have to do the following actions: 
24
25 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
26
27 2. Create a build directory:
28
29    % mkdir PARAVISADDONS_BUILD
30
31 3. Configure the build procedure:
32
33    % cd PARAVISADDONS_BUILD
34    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
35
36    where
37    - <mode> is either Release or Debug (default: Release);
38    - <installation_directory> is a destination folder to install SALOME PARAVISADDONS
39       module (default: /usr); 
40    - <path_to_src_dir> is a path to the PARAVISADDONS sources directory.
41
42
43 4. Build and install:
44
45    % make
46    % make install
47
48    This will install SALOME PARAVISADDONS module to the <installation_directory>
49    specified to cmake command on the previous step.
50
51 =============
52 Documentation
53 =============
54
55 ===============
56 Troubleshooting
57 ===============
58
59 Please, send a mail to webmaster.salome@opencascade.com.