core: eval_apply profile.
[mes.git] / README
diff --git a/README b/README
index dd8b1f8b7d178e0c3d0e76b1b3f199b10d3c6664..e952479fd060e985fa06b0a2b83316eb0fe0d07d 100644 (file)
--- a/README
+++ b/README
@@ -1,35 +1,86 @@
-                                                              -*- org -*-
-Mes -- Maxwell Equations of Software
+#+COMMENT:                                                            -*- org -*-
+#+TITLE: About GNU Mes
 
-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.
+#+SUBTITLE: Maxwell Equations of Software
 
-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.
+[[https://www.gnu.org/software/mes][GNU Mes]] brings a [[http://joyofsource.com/reduced-binary-seed-bootstrap.html][Reduced Binary Seed bootstrap]] to [[https://www.gnu.org/software/guix][GuixSD]] and
+potentially to any other interested GNU/Linux distribution, and aims
+to help create a full source bootstrap as part of the
+[[http://bootstrappable.org][bootstrappable builds]] effort.
 
-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.
+It consists of a mutual self-hosting Scheme interpreter written in
+~5,000 LOC of simple C and a Nyacc-based C compiler written in Scheme.
+This mes.c is [[https://github.com/oriansj/mes-m2][being simplified]] to be transpiled by [[https://github.com/oriansj/m2-planet][M2-Planet]].
 
-Mes is free software, it is distributed unde the terms of the GNU
-General Public Licence version 3 or later.  See the file COPYING.
+The Scheme interpreter (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]] --and test
+suite just barely enough to support a simple REPL and simple
+C-compiler: MesCC.
+
+Mes+MesCC can compile an only [[http://gitlab.com/janneke/tinycc][lightly patched TinyCC]] that is
+self-hosting.  Using this tcc and the Mes C library we now have a
+Reduced Binary Seed bootstrap for the gnutools triplet: glibc-2.2.5,
+binutils-2.20.1, gcc-2.95.3.  This is enough to bootstrap GuixSD for
+i686-linux and x86_64-linux.
+
+Mes is inspired by The Maxwell Equations of Software: [[http://www.softwarepreservation.org/projects/LISP/book/LISP%201.5%20Programmers%20Manual.pdf][LISP-1.5]] -- John
+McCarthy page 13, GNU Guix's source/binary packaging transparency and
+Jeremiah Orians's [[https://github.com/oriansj/stage0][stage0]] ~500 byte self-hosting hex assembler.
+
+GNU Mes is free software, it is distributed under the terms of the GNU
+General Public Licence version 3 or later.  See the file [[file:COPYING][COPYING]].
 
 * Get it
 
-   git clone https://gitlab.com/janneke/mes
+   #+BEGIN_SRC bash
+   git clone git://git.savannah.gnu.org/mes.git
+   #+END_SRC
 
-* Build it (see INSTALL for full instructions)
+* Build it (see [[file:INSTALL][INSTALL]] for full instructions)
 
+   #+BEGIN_SRC bash
    ./configure
    make all
    make check
+   #+END_SRC
 
 * REPL it
 
-   scripts/repl.mes
+   #+BEGIN_SRC bash
+   src/mes.gcc-out            # default (64 bit) gcc-compiled
+   src/mes.mes-gcc-out        # 32 bit, gcc -nostdlib, Mes C Lib
+   src/mes.mes-out            # 32 bit, bootstrapped, mes.M1+MesCC-compiled
+   src/mes.x86_64-mes-gcc-out # 64 bit, gcc -nostdlib, Mes C Lib
+   src/mes.x86_64-mes-out     # 64 bit, bootstrapped, mes.M1+MesCC-compiled
+   #+END_SRC
+
+* MesCC compiler
+
+   #+BEGIN_SRC bash
+   ./pre-inst env mescc -c scaffold/main.c
+   #+END_SRC
+
+* Bugs
+
+    Please send Mes bug reports to [[mailto:bug-mes@gnu.org][bug-mes@gnu.org]].
+
+* Links
+  [0] https://www.gnu.org/software/mes
+  [1] https://www.gnu.org/software/guix
+  [2] http://bootstrappable.org
+  [3] https://github.com/oriansj/mes-m2
+  [4] https://github.com/oriansj/m2-planet
+  [5] https://github.com/schemeway/lalr-scm
+  [6] https://www.cs.indiana.edu/chezscheme/syntax-case/old-psyntax.html
+  [7] https://www.nongnu.org/nyacc
+  [8] http://gitlab.com/janneke/tinycc
+  [9] [[http://www.softwarepreservation.org/projects/LISP/book/LISP%201.5%20Programmers%20Manual.pdf]]
+  [10] https://github.com/oriansj/stage0
 
-* Mescc compiler
+* Legalese
+Copyright © 2016,2017,2018 Jan (janneke) Nieuwenhuizen <[[mailto:janneke@gnu.org][janneke@gnu.org]]>
 
-   scripts/mescc.mes doc/examples/main.c
+  Copying and distribution of this file, with or without modification,
+  are permitted in any medium without royalty provided the copyright
+  notice and this notice are preserved.