aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README14
1 files changed, 6 insertions, 8 deletions
diff --git a/README b/README
index 1d481c7..ef0ef77 100644
--- a/README
+++ b/README
@@ -63,8 +63,7 @@ EO Introspection
> python setup.py install
--prefix option can be used, to install package into user's dir.
- PYTHONPATH env_var must be provided.
-
+ Add install_dir into PYTHONPATH.
1.3 To compile Cython files, cython (0.17) is required.
@@ -75,14 +74,13 @@ EO Introspection
or upgrade:
> pip install --upgrade cython
-
#####################################################
2. Introspecting folder and building class graph:
2.1 Folder introspection
Scanner runs recursively on defined folders
- > python eo_xml_gen.py --dir=IN_DIR --dir=IN_DIR2 --outdir=OUT_DIR -include=INCLUDE_DIR
+ > eo_xml_gen.py --dir=IN_DIR --dir=IN_DIR2 --outdir=OUT_DIR
script searches for dependencies in Python env paths.
If dependencies are not in Python search path,
--xmldir=XML_DIR can be needed
@@ -94,7 +92,7 @@ EO Introspection
# > python eo_graph_gen.py --dir=FOLDER_WITH_XML1 --dir=FOLDER_WITH_XMLS --outfile=OUTFILE.dot
# > dot -Tpng OUTFILE.dot -o out.png
# > eog out.png
- > python eo_graph_gen.py --dir=FOLDER_WITH_XML1
+ > eo_graph_gen.py --dir=FOLDER_WITH_XML1
--dir=FOLDER_WITH_XMLS --outfile=graph.png
> eog graph.png
@@ -103,7 +101,7 @@ EO Introspection
3. Generating python bindings
3.1 Generating python module for classes defined in XMLs:
- > python eo_py_gen.py --dir=XML_FOLDER --outdir=OUTDIR
+ > eo_py_gen.py --dir=XML_FOLDER --outdir=OUTDIR
--pkg="lib1 lib2" --module=MODULE_NAME --xmldir=INCLUDE_XML_DIR
-lname -I/include -DSOME_VAR=1
@@ -182,13 +180,13 @@ EO Introspection
According to layout, package 'eorepo' will be installed into
installation path.
- And it can be used as following:
+ It can be used as following:
from eorepo.eobase import EoBase
#####################################################################
4. Generating js module for classes defined in XMLs:
- a. > python eo_js_gen.py --dir=XML_FOLDER --outdir=OUTDIR
+ a. > eo_js_gen.py --dir=XML_FOLDER --outdir=OUTDIR
--module=MODULE_NAME --xmldir=INCLUDE_XML_DIR -lname -I/include
-DSOME_PATH=\"/path\"