1. camlspotter
  2. orakuda

Commits

camlspotter  committed b261106

doc fix

  • Participants
  • Parent commits 29931d8
  • Branches dev

Comments (0)

Files changed (2)

File README.md

View file
  • Ignore whitespace
     
 A good name for Perlish OCaml, isn't it ?
 
-## How to build ##
+## How to install ##
+
+### From source ###
 
 Requirements: OCaml 3.12.0, findlib, pcre-ocaml, omake, spotlib
 
   then compile+install the compiler. The patch should work for upto 4.00.0
   with trivial fixes.
 
-* build the library and pa_* extensions: ``cp OMakeroot.in yes no | omake`` + ``omake install``
+* build the library and pa_* extensions:
+
+    $ ocaml setup.ml -configure
+	$ ocaml setup.ml -build
+	$ ocaml setup.ml -install
 
 * ``omake top_test`` launches a toplevel with the extension
 
+### Via OPAM ###
+
+    $ opam install orakuda
+
 ## How to use ##
 
 For easier access to functions, users are recommend to declare:
    
 at the begining of their source file.
 
-### (OPTIONAL) $ Prefix ###  
+### `$` Prefix (OPTIONAL) ###  
 
 If you extend your CamlP4, 
 ORakuda extends OCaml's lexer and introduces new lexer rules
 If you use the original CamlP4, you cannot use $ Prefix sytanx, but
 still you can use the normal CamlP4 quoatations to write the same things.
     
-### Perl like PCRE $/.../ (or <:m<...>>) ###
+### Perl like PCRE ``$/.../`` (or ``<:m<...>>``) ###
 
-#### SYNTAX: ####
+#### SYNTAX ####
 
         $/regular expression/flags      (with patched P4)
         <:m<regular expression>> 

File _oasis

View file
  • Ignore whitespace
 OASISFormat: 0.2
 Name:        orakuda
-Version:     1.1.0
+Version:     1.1.1
 Synopsis:    ORakuda, Perlish string literals in OCaml
 Authors:     Jun FURUSE
 License:     LGPL-2.0 with OCaml linking exception