X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=README;h=d0c8b133851c2dfadc5169aa6ab67d3b58d6cd02;hb=4f8971025e9431049a97c260fa586fe64bde22d2;hp=4f5dfd8fb7b774ac24ba93b1216cbaa830358ca7;hpb=49e925ab0fad9e8715fb1f932cccba5da28f954f;p=ocaml-bitstring.git diff --git a/README b/README index 4f5dfd8..d0c8b13 100644 --- a/README +++ b/README @@ -1,20 +1,28 @@ ocaml-bitmatch copyright (C) 2008 Red Hat Inc. License: LGPLv2+ with OCaml linking exception. -Please see the doc/ subdirectory for developer documentation. +Please see the html subdirectory for developer documentation. -The only dependencies are OCaml >= 3.10.0, camlp4, and findlib. +The only requirements are OCaml >= 3.10.0, camlp4, ocamldoc, and findlib. + +If you optionally have CIL (http://cil.sourceforge.net/) installed +then there are some nice extra tools for converting C header files +into matchable OCaml structures. To build: ./configure make - make test # optional, to run tests +Other make targets: + + make test # build and run the test suite + + make examples # build the examples - make print-tests # optional, to print expanded test macros - make print-examples # optional, to print expanded example macros + make print-tests # print expanded test macros + make print-examples # print expanded example macros -To install, run this as root: +To install (as root): make install