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