shorten column-based param names wrt common prefix
[sqlgg.git] / README.txt
blobed9ecc497283c8816492ef9ece02d2b1c047c38f
2 Build
3 =====
5 Dependencies
6 ------------
8 * menhir
9 * extlib
10 * oUnit
11 * deriving
12 * ocamlfind (optional)
14 `deriving` is special. There are two ways :
16 * Use patched version available at <http://repo.or.cz/w/deriving.git>.
17   It is a recommended approach as everything should work out of the box.
19 * Otherwise, get the original version from <http://code.google.com/p/deriving>.
20   It will cause linking conflicts with `extLib` (see 
21   <http://code.google.com/p/deriving/issues/detail?id=1>).
22   So you have to edit `deriving/lib/Makefile` (remove the `enum.ml enum.mli` 
23   line from SOURCES variable) and rebuild. Mind that it won't
24   [build cleanly on Windows](http://code.google.com/p/deriving/issues/detail?id=3).
25   Also it doesn't install via ocamlfind and only provides a standalone
26   preprocessor. So make sure ocamlbuild will find `deriving.cma` and edit
27   `src/_tags` to invoke preprocessor directly - replace flags `camlp4o, pa_deriving`
28   with `pp(path/to/deriving/preprocessor)`.
30 Dependencies will be found with ocamlfind by default.
31 Additionaly you can create `src/myocamlbuild.config` and manually 
32 specify paths to some libraries as follows :
34     extlib=C:/my/contrib/extlib-1.5.1
35     deriving=C:/my/contrib/deriving-0.1.1/lib
36     oUnit=C:/my/contrib/ounit-1.0.3
38 Build
39 -----
41 Change to `src` directory and run `make` (or `build.bat` on Windows).
43 Windows users
44 =============
46 Install VS2005 SP1 redistributable
47 <http://www.microsoft.com/downloads/details.aspx?FamilyID=200b2fd9-ae1a-4a14-984d-389c36f85647>
49 ----
50 2010-02-26