add AVM2 instructions

[happyabc/happyabc.git] / README.mkdn

diff --git a/README.mkdn b/README.mkdn
index ac9b542..dd95c27 100644 (file)
--- a/README.mkdn
+++ b/README.mkdn
@@ -1,25 +1,55 @@
-Happy ABC: a Scheme compiler for Flash
-======================================
+Happy ABC: a Scheme compiler for Flash 9/10
+===========================================
 
 OVERVIEW
 --------
-Adobe Flash is greatly usefull and powerfull tools. And more,it could run on
-many platform. Flash is very good,however, ActionScrpit is *very* dull. I
-tired for explicit type annotation heavy compiler,and confusing `this` rule.
+Happy ABC is a scheme compiler for Flash 9/10. Main features is following:
 
-Happy ABC is a scheme compiler. This could generate Flash(swf). The main
-futeres are fast compiler, brief `this` rule.
+1. Faster than official compiler(mxmlc), because written by OCaml.
+2. NO ActionScript!
 
-Implicit type, e.g. type infer, remains for future work. :D
+PREREQUISITES
+-------------
+
+* ocaml 3.11 or latter
+* omake
+* findlib
+* extlib
+* xml-light
+* oUnit(for unit test)
+* hevea
 
 INSTALL
 -------
-See the file INSTALL for installation instructions.
+
+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
+-------
+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@happyabc.org)