mescc: Have micro-mes use strcmp to print help.
[mes.git] / README
diff --git a/README b/README
index dd8b1f8b7d178e0c3d0e76b1b3f199b10d3c6664..1bb0c6b9d9ad70c8f1754f5ed7debe29c58b668c 100644 (file)
--- a/README
+++ b/README
@@ -4,16 +4,24 @@ Mes -- Maxwell Equations of Software
 Mes aims to create an entirely source-based bootstrapping path.  The
 target is to [have GuixSD] boostrap from a minimal, easily inspectable
 binary --that should be readable as source-- into something close to
-R5RS Scheme.
+R6RS Scheme.
 
 As bootstrapping is presumably easiest and probably most fun with
 Scheme, the next step for Mes is mescc: a C compiler/linker to
 boostrap into GNU Gcc and GNU Guile, possibly via Tiny-CC.
 
+It currently has an interpreter written in C (mes) with Garbage
+Collector (Jam Scraper), a library of loadable Scheme modules--
+notably [[https://github.com/schemeway/lalr-scm][Dominique Boucher's LALR]], [[https://www.cs.indiana.edu/chezscheme/syntax-case/old-psyntax.html][Pre-R6RS portable syntax-case]] with
+R7RS ellipsis, [[http://www.nongnu.org/nyacc/][Nyacc]] and [[https://www.gnu.org/software/guile/docs/master/guile.html/PEG-Parsing.html][Guile's PEG]] --and test suite just barely
+enough to support a simple REPL (repl.mes) and a proof-of-concept
+C-compiler (mescc.mes) that produces an elf from the simplest of C
+files.
+
 Mes is inspired by The Maxwell Equations of Software: [[http://www.softwarepreservation.org/projects/LISP/book/LISP%25201.5%2520Programmers%2520Manual.pdf][LISP-1.5]] -- John
 McCarthy page 13.
 
-Mes is free software, it is distributed unde the terms of the GNU
+Mes is free software, it is distributed under the terms of the GNU
 General Public Licence version 3 or later.  See the file COPYING.
 
 * Get it
@@ -32,4 +40,18 @@ General Public Licence version 3 or later.  See the file COPYING.
 
 * Mescc compiler
 
-   scripts/mescc.mes doc/examples/main.c
+   scripts/mescc.mes doc/examples/main.c > a.out
+
+* Other
+
+   make check
+   make mes-check
+   make paren
+   make mescc
+   scripts/nyacc-calc.mes
+   scripts/nyacc.mes
+
+   make guile-check
+   make guile-mescc
+   guile/nyacc-calc.scm
+   scripts/nyacc.scm