guix: Add nyacc-for-mes.
[mes.git] / README
diff --git a/README b/README
index 0ad3736ba7142892b8d3c26f5387725d11607e73..c688d2dca7dd54a61e15071413d321f1908d759e 100644 (file)
--- a/README
+++ b/README
@@ -1,39 +1,58 @@
+                                                              -*- org -*-
 Mes -- Maxwell Equations of Software
 
-Mes is inspired by The Maxwell Equations of Software -- John McCarthy page 13
-http://www.softwarepreservation.org/projects/LISP/book/LISP%201.5%20Programmers%20Manual.pdf
-
-Its aim is to have GuixSD boostrap from a minimal trusted binary into
-Scheme.  The strategy is to use OrianJs self-hosting hex assembler to
-write a minimal LISP called MES to bootstrap a full fledged Scheme,
-written in MES.
-
-Mes is free software, it is distributed unde the terms of the GNU
+[[https://gitlab.com/janneke/mes][Mes]] aims to help create full source bootstrapping for [[https://www.gnu.org/software/guix][GuixSD]] as part
+of the [[http://bootstrappable.org][bootstrappable builds]] effort.
+
+It currently consists of a mutual self-hosting Scheme interpreter
+prototype written in C and a Nyacc-based C compiler written in Scheme.
+This C prototype is being simplified to be transpiled by [[https://github.com/oriansj/m2-planet][M2-Planet]].
+
+The Scheme interpreter prototype (mes.c) has a Garbage Collector, a
+library of loadable Scheme modules-- notably Dominique Boucher's [[https://github.com/schemeway/lalr-scm][LALR]],
+Pre-R6RS [[https://www.cs.indiana.edu/chezscheme/syntax-case/old-psyntax.html][portable syntax-case]] with R7RS ellipsis, Matt Wette's [[https://www.nongnu.org/nyacc][Nyacc]],
+Guile's [[https://www.gnu.org/software/guile/docs/master/guile.html/PEG-Parsing.html][PEG]] --and test suite just barely enough to support a simple
+REPL and simple C-compiler: MesCC.
+
+Mes+MesCC can compile a only [[https://gitlab.com/janneke/tinycc][lightly modified TinyCC]] that is
+self-hosting.  A GNU Ccc-compiled tcc is [[https://lists.gnu.org/archive/html/tinycc-devel/2017-05/msg00103.html][known]] to compile GCC.
+
+Mes is inspired by The Maxwell Equations of Software: [[http://www.softwarepreservation.org/projects/LISP/book/LISP%2525201.5%252520Programmers%252520Manual.pdf][LISP-1.5]] -- John
+McCarthy page 13, GNU Guix's source/binary packaging transparency and
+Jeremiah Orians's stage0 ~300 byte self-hosting hex assembler.
+
+[0] https://gitlab.com/janneke/mes
+[1] https://www.gnu.org/software/guix
+[2] http://bootstrappable.org
+[3] https://github.com/oriansj/m2-planet
+[4] https://github.com/schemeway/lalr-scm
+[5] https://www.cs.indiana.edu/chezscheme/syntax-case/old-psyntax.html
+[6] https://www.nongnu.org/nyacc
+[7] https://www.gnu.org/software/guile/docs/master/guile.html/PEG-Parsing.html
+[8] https://gitlab.com/janneke/tinycc
+[9] https://lists.gnu.org/archive/html/tinycc-devel/2017-05/msg00103.html
+[10] http://www.softwarepreservation.org/projects/LISP/book/LISP%25201.5%2520Programmers%2520Manual.pdf
+[11] https://github.com/oriansj/stage0
+
+Mes is free software, it is distributed under the terms of the GNU
 General Public Licence version 3 or later.  See the file COPYING.
 
-Current targets.
-
-* make check
-
-* C compiler
-
-   make mescc
-   make guile-mescc
-
-from there, work on mescc.scm, main.c.
+* Get it
 
-* Transition to syntax-if.scm (still using syntax-cond.scm)
+   git clone https://gitlab.com/janneke/mes
 
-* syntax-case using portable psyntax.pp
+* Build it (see INSTALL for full instructions)
 
-   make psyntax
+   ./configure
+   make all
+   make check
 
-* syntax-case using define-macro
+* REPL it
 
-   make syntax-case
-   make guile-syntax-case
+   src/mes.gcc        # default (64 bit) gcc-compiled
+   src/mes.mlibc-gcc  # 32 bit, gcc -nostdlib
+   src/mes            # 32 bit, bootstrapped, mes.M1+MesCC-compiled
 
-* PEG
+* MesCC compiler
 
-   make peg
-   make guile-peg
+   scripts/mescc -c scaffold/main.c