fix META, add ocamlfind usage example in README
[deriving.git] / README
blob0c9e1c350e1bde937285be937c1a7cec5a96a55b
1 Typing `make' in this directory should build both the preprocessor
2 (syntax/deriving) and the libraries (lib/deriving.cma,
3 lib/deriving.cmxa).
5 You can run the tests by changing to the test directory and building
6 and running the `tests' executable
8    $ cd tests
9    $ make
10    ...
11    $ ./tests
12    Tests succeeded!
14 There's very limited documentation at present, but you should be able
15 to get started by looking at the test files.
17 Any comments are very welcome.
19 Jeremy Yallop
20 jeremy.yallop@ed.ac.uk
22 Build with ocamlbuild and install via findlib :
23     $ make install
25 Example usage with ocamlfind :
26     $ ocamlfind ocamlopt -o test -linkpkg -package deriving,deriving.syntax -syntax camlp4o tests/issue2.ml