Add README

README.rst

@@ -0,0 +1,39 @@
+G1M-assembler
+*******
+
+Introduction
+============
+
+G1M-assembler is a Text-to-BasicCasio converter tools.
+
+Manual
+======
+
+See the `mkg1m(1)`_ manual page for instructions to run the tool.
+
+.. _`mkg1m(1)`: man/mkg1m.1
+
+License
+=======
+
+CastXML is licensed under the `GPL V3`_.
+See the `<LICENSE>`__ and `<NOTICE>`__ files for details.
+
+Build
+=====
+
+To build g1m-assembler tools from source, first obtain the prerequisites:
+
+* A C/C++ compiler
+
+* `CMake`_ cross-platform build system generator.
+
+Run CMake on the source tree to generate a build tree using
+a compiler compatible.
+
+Run the corresponding native build tool (e.g. ``make``) in the 
+build tree, and optionally build the ``install`` target.  The ``g1m-assembler``
+command-line tools may be used either from the build tree or the install tree.
+The install tree is relocatable.
+
+.. _`CMake`: http://www.cmake.org/