Commits

camlspotter committed 7e43d34

document

  • Participants
  • Parent commits bd49db3
  • Branches dev

Comments (0)

Files changed (1)

 
 ## How to use ##
 
+### Toplevel
+
+To load:
+
+    $ ocaml -I $OCAML_TOPLEVEL_PATH    # $OCAML_TOPLEVEL_PATH should point the directory with the file topfind
+    # #use "topfind";;
+	# #camlp4o;;
+	# #require "orakuda";;
+	# #require "orakuda.syntax";;
+
+To see the syntax extension working correctly:
+
+    # <:m<hello world>>;;
+	
+### Link
+
+Add the following to your OCamlFind+OCaml flags:
+
+    -syntax camlp4o -package orakuda,orakuda.syntax
+
+For example,
+
+    ocamlfind ocamlc -syntax camlp4o -package orakuda,orakuda.syntax -c x.ml
+	
+### Common pattern in .ml
+
 For easier access to functions, users are recommend to declare:
 
     open Rakuda.Std