Salome HOME
Windows compatibility
[modules/paravis.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index c828a2beeb90e474be52a2e9f819147dcad2d208..f1d93cb4648ffb3586480fea49dd329dd9edc671 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1 +1,30 @@
-PARAVIS module
+Building and installing PARAVIS module
+======================================
+
+PARAVIS is a SALOME module that wraps ParaView GUI and makes it available in
+SALOME GUI.
+
+Like any other SALOME module, PARAVIS requires PARAVIS_ROOT_DIR environment variable to be set to PARAVIS
+installation directory.
+
+Specific prerequisites:
+- cmake 2.8.10 or higher should be installed, path to cmake executable
+should be added to PATH environment variable.
+- ParaView-4.3.1, should be installed
+
+It also requires common SALOME environment including GUI_ROOT_DIR and
+other standard SALOME prerequisites.
+
+As soon as the environment is set, execute the following commands in a shell:
+
+mkdir PARAVIS_BUILD
+cd PARAVIS_BUILD
+ccmake ../PARAVIS_SRC
+make 
+make install
+
+PARAVIS module can be launched using the following commands:
+
+salome -mMED,PARAVIS
+
+