README.txt

   1 sqlgg: SQL Guided (code) Generator
   2
   3 Homepage at http://ygrek.org.ua/p/sqlgg/
   4
   5 Build
   6 =====
   7
   8 Dependencies
   9 ------------
  10
  11 * menhir
  12 * extlib
  13 * oUnit
  14 * deriving
  15 * ocamlfind (optional)
  16
  17 `deriving` is special - there are several forks floating around.
  18
  19 * Patched version available at <http://repo.or.cz/w/deriving.git> or
  20   deriving-ocsigen are recommended - everything should work out of the box.
  21
  22 * Otherwise, get the original version from <http://code.google.com/p/deriving>.
  23   It will cause linking conflicts with `extLib` (see
  24   <http://code.google.com/p/deriving/issues/detail?id=1>).
  25   So you have to edit `deriving/lib/Makefile` (remove the `enum.ml enum.mli`
  26   line from SOURCES variable) and rebuild. Mind that it won't
  27   [build cleanly on Windows](http://code.google.com/p/deriving/issues/detail?id=3).
  28   Also it doesn't install via ocamlfind and only provides a standalone
  29   preprocessor. So make sure ocamlbuild will find `deriving.cma` and edit
  30   `src/_tags` to invoke preprocessor directly - replace flags `camlp4o, pa_deriving`
  31   with `pp(path/to/deriving/preprocessor)`.
  32
  33 Dependencies will be found with ocamlfind by default.
  34 Additionaly it is possible to specify paths to dependencies in `src/myocamlbuild.config`,
  35 e.g.:
  36
  37     extlib=C:/my/contrib/extlib-1.5.1
  38     deriving=C:/my/contrib/deriving-0.1.1/lib
  39     oUnit=C:/my/contrib/ounit-1.0.3
  40
  41 Build
  42 -----
  43
  44 Change to `src` directory and run `make` (or `build.bat` on Windows).
  45
  46 Windows users
  47 =============
  48
  49 Install VS2005 SP1 redistributable
  50 <http://www.microsoft.com/downloads/details.aspx?FamilyID=200b2fd9-ae1a-4a14-984d-389c36f85647>
  51
  52 ----
  53 2013-09-16