X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=README;h=d0c8b133851c2dfadc5169aa6ab67d3b58d6cd02;hb=1be1a65d5fc5727d20e465bebaafcad263b87162;hp=75edaf542e28c9aa194e9da39b8376bac740bc81;hpb=2fecbba3804b3788af08786e580483dac9a45294;p=ocaml-bitstring.git diff --git a/README b/README index 75edaf5..d0c8b13 100644 --- a/README +++ b/README @@ -3,18 +3,26 @@ License: LGPLv2+ with OCaml linking exception. Please see the html subdirectory for developer documentation. -The only dependencies are OCaml >= 3.10.0, camlp4, ocamldoc, 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