doc: Release update.
[mes.git] / README
1                                                               -*- org -*-
2 Mes -- Maxwell Equations of Software
3
4 [[https://gitlab.com/janneke/mes][Mes]] aims to help create full source bootstrapping for [[https://www.gnu.org/software/guix][GuixSD]] as part
5 of the [[http://bootstrappable.org][bootstrappable builds]] effort.
6
7 It currently consists of a mutual self-hosting Scheme interpreter
8 prototype written in C and a Nyacc-based C compiler written in Scheme.
9 This C prototype is [[https://github.com/oriansj/mes-m2][being simplified]] to be transpiled by [[https://github.com/oriansj/m2-planet][M2-Planet]].
10
11 The Scheme interpreter prototype (mes.c) has a Garbage Collector, a
12 library of loadable Scheme modules-- notably Dominique Boucher's [[https://github.com/schemeway/lalr-scm][LALR]],
13 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]],
14 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
15 REPL and simple C-compiler: MesCC.
16
17 Mes+MesCC can compile an only [[https://gitlab.com/janneke/tinycc][lightly patched TinyCC]] that is
18 self-hosting.  Using this tcc and the Mes C library we now have a
19 reduced-binary-seed bootstrap for the gnutools triplet: glibc-2.2.5,
20 binutils-2.20.1, gcc-4.1.0.
21
22 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
23 McCarthy page 13, GNU Guix's source/binary packaging transparency and
24 Jeremiah Orians's [[https://github.com/oriansj/stage0][stage0]] ~500 byte self-hosting hex assembler.
25
26 Mes is free software, it is distributed under the terms of the GNU
27 General Public Licence version 3 or later.  See the file COPYING.
28
29 * Get it
30
31    git clone https://gitlab.com/janneke/mes
32
33 * Build it (see INSTALL for full instructions)
34
35    ./configure
36    make all
37    make check
38
39 * REPL it
40
41    src/mes.gcc        # default (64 bit) gcc-compiled
42    src/mes.mlibc-gcc  # 32 bit, gcc -nostdlib
43    src/mes            # 32 bit, bootstrapped, mes.M1+MesCC-compiled
44
45 * MesCC compiler
46
47    scripts/mescc -c scaffold/main.c
48
49 * Bugs
50
51     Please send Mes bug reports to janneke@gnu.org.
52
53 [0] https://gitlab.com/janneke/mes
54 [1] https://www.gnu.org/software/guix
55 [2] http://bootstrappable.org
56 [3] https://github.com/oriansj/mes-m2
57 [4] https://github.com/oriansj/m2-planet
58 [5] https://github.com/schemeway/lalr-scm
59 [6] https://www.cs.indiana.edu/chezscheme/syntax-case/old-psyntax.html
60 [7] https://www.nongnu.org/nyacc
61 [8] https://www.gnu.org/software/guile/docs/master/guile.html/PEG-Parsing.html
62 [9] https://gitlab.com/janneke/tinycc
63 [10] http://www.softwarepreservation.org/projects/LISP/book/LISP%25201.5%2520Programmers%2520Manual.pdf
64 [11] https://github.com/oriansj/stage0