Add .ocamlinit.

[happyabc/happyabc.git] / README.mkdn

diff --git a/README.mkdn b/README.mkdn
index d127b48..dd95c27 100644 (file)
--- a/README.mkdn
+++ b/README.mkdn
@@ -1,26 +1,59 @@
-Scheme compiler for ActionScript3 VM
-====================================
+Happy ABC: a Scheme compiler for Flash 9/10
+===========================================
 
-REQUIRES
+OVERVIEW
 --------
+Happy ABC is a scheme compiler for Flash 9/10. Main features is following:
 
-* ocaml >= 3.10
-* GODI for 3.10
-* ExtLib >= 1.5.0
-* OUnit >= 1.0.0
+1. Faster than official compiler(mxmlc), because written by OCaml.
+2. NO ActionScript!
 
-ExtLib&OUnit should be installed by GODI.
+PREREQUISITES
+-------------
 
-BUILD
------
-    
-    $ sudo godi_console perform -build godi-extlib 
-    $ make
+* ocaml 3.11 or latter
+* omake
+* findlib
+* extlib
+* xml-light
+* oUnit(for unit test)
+* hevea
+
+INSTALL
+-------
+
+If you type:
+
+    $ omake config
+    $ omake all
+    $ (omake check)
+    $ (sudo) omake install
+
+then install to a default directory(/usr/local/).
+
+Or,install to another directory:
+
+    $ omake config PREFIX=/path/to/
+    $ omake all
+    $ (omake check)
+    $ (sudo) omake install
+
+DOCUMENTS
+---------
+Not yet. See `example/`.
 
 LICENCE
 -------
-This promgram is free software; you can distribute it and modify it under MIT Licence.
+pa_oo.ml is written by Jacques Garrigue. and modified by OGASAWARA Satoshi., license is BSD.
+
+pa_openin.ml is written by Alain Frisch., licence is Public Domain.
+
+Other codes is written by MIZUNO Hiroki., licence is MIT Licence.
 
 AUTHOR
 ------
-MIZUNO "mzp" Hiroki (mzp_at_ocaml.jp)
+MIZUNO "mzp" Hiroki (mzp@happyabc.org)
+
+AVAILABILITY
+------------
+The complete HappyABC distribution can be accessed at this[http://happyabc.org].