doc: Release update.
[mes.git] / README
1 #+COMMENT:                                                            -*- org -*-
2 #+TITLE: About GNU Mes
3
4 #+SUBTITLE: Maxwell Equations of Software
5
6 [[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][Guix]] and potentially
7 to any other interested GNU/Linux distribution, and aims to help
8 create a full source bootstrap as part of the [[http://bootstrappable.org][bootstrappable builds]]
9 effort.
10
11 It consists of a mutual self-hosting Scheme interpreter written in
12 ~5,000 LOC of simple C and a Nyacc-based C compiler written in Scheme.
13 This mes.c is [[https://github.com/oriansj/mes-m2][being simplified]] to be transpiled by [[https://github.com/oriansj/m2-planet][M2-Planet]].
14
15 The Scheme interpreter (mes.c) has a Garbage Collector, a library of
16 loadable Scheme modules-- notably Dominique Boucher's [[https://github.com/schemeway/lalr-scm][LALR]], Pre-R6RS
17 [[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
18 suite just barely enough to support a simple REPL and simple
19 C-compiler: MesCC.
20
21 Mes+MesCC can compile an only [[http://gitlab.com/janneke/tinycc][lightly patched TinyCC]] that is
22 self-hosting.  Using this tcc and the Mes C library we now have a
23 Reduced Binary Seed bootstrap for the gnutools triplet: glibc-2.2.5,
24 binutils-2.20.1, gcc-2.95.3.  This is enough to bootstrap Guix for
25 i686-linux and x86_64-linux.
26
27 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
28 McCarthy page 13, GNU Guix's source/binary packaging transparency and
29 Jeremiah Orians's [[https://github.com/oriansj/stage0][stage0]] ~500 byte self-hosting hex assembler.
30
31 GNU Mes is free software, it is distributed under the terms of the GNU
32 General Public Licence version 3 or later.  See the file [[file:COPYING][COPYING]].
33
34 * Get it
35
36    #+BEGIN_SRC bash
37    git clone git://git.savannah.gnu.org/mes.git
38    #+END_SRC
39
40 * Build it (see [[file:INSTALL][INSTALL]] for full instructions)
41
42    #+BEGIN_SRC bash
43    ./configure
44    make all
45    make check
46    #+END_SRC
47
48 * REPL it
49
50    #+BEGIN_SRC bash
51    src/mes.gcc-out            # default (64 bit) gcc-compiled
52    src/mes.mes-gcc-out        # 32 bit, gcc -nostdlib, Mes C Lib
53    src/mes.mes-out            # 32 bit, bootstrapped, mes.M1+MesCC-compiled
54    src/mes.x86_64-mes-gcc-out # 64 bit, gcc -nostdlib, Mes C Lib
55    src/mes.x86_64-mes-out     # 64 bit, bootstrapped, mes.M1+MesCC-compiled
56    #+END_SRC
57
58 * MesCC compiler
59
60    #+BEGIN_SRC bash
61    ./pre-inst env mescc -c scaffold/main.c
62    #+END_SRC
63
64 * Bugs
65
66     Please send Mes bug reports to [[mailto:bug-mes@gnu.org][bug-mes@gnu.org]].
67
68 * Links
69   [0] https://www.gnu.org/software/mes
70   [1] https://www.gnu.org/software/guix
71   [2] http://bootstrappable.org
72   [3] https://github.com/oriansj/mes-m2
73   [4] https://github.com/oriansj/m2-planet
74   [5] https://github.com/schemeway/lalr-scm
75   [6] https://www.cs.indiana.edu/chezscheme/syntax-case/old-psyntax.html
76   [7] https://www.nongnu.org/nyacc
77   [8] http://gitlab.com/janneke/tinycc
78   [9] [[http://www.softwarepreservation.org/projects/LISP/book/LISP%201.5%20Programmers%20Manual.pdf]]
79   [10] https://github.com/oriansj/stage0
80
81 * Legalese
82 Copyright © 2016,2017,2018 Jan (janneke) Nieuwenhuizen <[[mailto:janneke@gnu.org][janneke@gnu.org]]>
83
84   Copying and distribution of this file, with or without modification,
85   are permitted in any medium without royalty provided the copyright
86   notice and this notice are preserved.