.

git-svn-id: svn+ssh://idea.nguyen.vg/svn/sxsi/trunk/xpathcomp@85 3cdefd35-fc62-479d-8e8d-bae585ffb9ca

diff --git a/HACKING b/HACKING
new file mode 100644 (file)
index 0000000..92af1c6
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,46 @@
+Compilation instruction:
+
+compile the TextCollection :
+
+cd XMLTree/TextCollection
+make
+
+compile libcds :
+
+cd XMLTree/libcds
+make
+
+compile XMLTree :
+cd XMLTree
+make
+
+compile xpathcomp/
+make
+
+you can compile with make DEBUG=true to get more statistics the overall programm is slower
+but you get precise timing for each individual function calls to the XMLTree interface.
+
+
+Usage :
+./main 'file.xml' 'query' [output]
+
+file.xml is the input file. There are some in the tests subdirectory. At the moment you can mainly test
+with base.xml and tiny.xml. Any file bigger than this will take too much time to load.
+
+
+output is optional. If specified, it is the name of a file to which the result of the query is serialized.
+If output is not given, the the result of the query is kept as a set of identifier and no access to
+the string collection is made.
+
+
+There are a few flags:
+
+-f sample factor [default=64]
+-i index empty texts [default=false]
+-d Disable text collection[default=false]
+-help  Display this list of options
+--help  Display this list of options
+
+
+for instance:
+./main -f 29 -d tests/tiny.xml '//para'