X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=README;h=e6da02d2381d518874ae2c452516423d432d1fc5;hb=a7932dd74a91ebf54128bf5456e6a0054fc506c5;hp=4f5dfd8fb7b774ac24ba93b1216cbaa830358ca7;hpb=49e925ab0fad9e8715fb1f932cccba5da28f954f;p=ocaml-bitstring.git diff --git a/README b/README index 4f5dfd8..e6da02d 100644 --- a/README +++ b/README @@ -1,20 +1,24 @@ 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 dependencies are OCaml >= 3.10.0, camlp4, ocamldoc, and findlib. To build: ./configure make - make test # optional, to run tests +Other make targets: - make print-tests # optional, to print expanded test macros - make print-examples # optional, to print expanded example macros + make test # build and run the test suite -To install, run this as root: + make examples # build the examples + + make print-tests # print expanded test macros + make print-examples # print expanded example macros + +To install (as root): make install