]> SALOME platform Git repositories - tools/hxx2salome.git/blob - README
Salome HOME
set-up .gitignore file
[tools/hxx2salome.git] / README
1 Content:
2 -------
3
4
5 This Folder contains :
6   - script      : the sources of the generator,
7   - src         : the sources of the GUI
8   - CppExamples : Some C++ component examples.
9   - Doc         : the associated documentation.
10
11
12 The generator is a script file called hxx2salome, written in bash, that manage :
13   - the code generation
14   - the compilation of generated module
15   - the update of Salome environment file
16
17 A GUI called ghx2salome, written with Qt, is wrapping the script.
18
19
20
21 Install:
22 -------
23
24   The script can be used without any compilation.
25   To use the GUI, you first have to install and compile it.
26
27   ./build_configure
28   ./configure --prefix=<absolute path of HXX2SALOME>
29   make
30   make install
31
32
33        
34 Usage:
35 -----
36
37     set HXX2SALOME_ROOT_DIR variable to <absolute path of HXX2SALOME/bin>
38
39     with GUI : 
40     --------
41        
42        ${HXX2SALOME_ROOT_DIR}/gxx2salome
43
44     with script :
45     -----------
46       
47        ${HXX2SALOME_ROOT_DIR}/hxx2salome [OPTIONS]  cppComponent_root_dir   cppComponent.hxx   libcppComponent.so  salome_install_dir
48     
49          - cppComponent_root_dir : install directory (absolute path) of the c++ component
50          - cppComponent.hxx : header of the component
51          - libcppComponent.so :shared library of the component
52            (cppComponent.hxx and libcppComponent.so have to be found in cppComponent_root_dir!)
53          - salome_install_dir : the directory where you want to install the generated component
54
55        OPTIONS:
56          -c : to compile after code generation
57          -l : to launch salome after compilation
58          -e environment_file  : to specify an salome environment file to source (for compiling)
59
60
61
62        Examples:
63
64          The following examples are based upon the C++ component given in CppExamples directory. 
65          To proceed it is first necessary to compile them.
66
67          - export HXX2SALOME_ROOT_DIR=/home/crouzet/HXX2SALOME/bin;
68
69          - $HXX2SALOME_ROOT_DIR/hxx2salome -c -l -e /home/crouzet/SALOME2/my_env_products.sh /home/crouzet/SALOME2/CPP/COMPO_CXX_INSTALL 
70                                             Calculator.hxx libCALCULATORCXX.so /home/crouzet/SALOME2
71     
72          - $HXX2SALOME_ROOT_DIR/hxx2salome -c  -e /home/crouzet/SALOME2/my_env_products.sh /home/crouzet/SALOME2/CPP/COMPO_CXX_INSTALL 
73                                             Calc.hxx libCALCULCXX.so /home/crouzet/SALOME2
74
75     
76