doc: Migration to Libera Chat.
[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]] is a Scheme interpreter and C compiler for bootstrapping the GNU
7 System.  Since version 0.22 it has again helped to halve the size of
8 opaque, uninspectable binary seeds that are currently being used in the
9 [[https://guix.gnu.org/blog/2019/guix-reduces-bootstrap-seed-by-50/][Reduced Binary Seed bootstrap]] of [[https://www.gnu.org/software/guix][GNU Guix]].  The final goal is to help
10 create a full source bootstrap as part of the [[http://bootstrappable.org][bootstrappable builds]]
11 effort for UNIX-like operating systems.
12
13 The Scheme interpreter is written in ~5,000 LOC of simple C, and the C
14 compiler written in Scheme and these are mutual self-hosting.  This
15 mes.c is now being simplified to be transpiled by [[https://github.com/oriansj/m2-planet][M2-Planet]].
16
17 Mes has a Garbage Collector, a library of loadable Scheme modules--
18 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
19 R7RS ellipsis, Matt Wette's [[https://www.nongnu.org/nyacc][Nyacc]] --and test suite, just enough to
20 support a REPL and a C99 compiler: mescc.
21
22 Mes + MesCC + Mes C Library can build a [[https://gitlab.com/janneke/tinycc][bootstrappable 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, x86_64-linux, armhf-linux and aarch64-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 We are very grateful to NLNet for sponsoring the
33 [[https://nlnet.nl/project/GNUMes][Reduced Binary Seed bootstrap]] and the [[https://nlnet.nl/project/GNUMes-arm][ARM port]].
34
35 GNU Mes is free software, it is distributed under the terms of the GNU
36 General Public Licence version 3 or later.  See the file [[file:COPYING][COPYING]].
37
38 * Get it
39
40    #+BEGIN_SRC bash
41    git clone git://git.savannah.gnu.org/mes.git
42    #+END_SRC
43
44 * Build it (see [[file:INSTALL][INSTALL]] for full instructions)
45
46    #+BEGIN_SRC bash
47    ./configure
48    make all
49    make check
50    #+END_SRC
51
52 * REPL it
53
54    #+BEGIN_SRC bash
55    ./pre-inst-env mes
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://guix.gnu.org/blog/2020/guix-further-reduces-bootstrap-seed-to-25
71   [2] https://www.gnu.org/software/guix
72   [3] https://bootstrappable.org
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] https://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   [11] https://nlnet.nl/project/GNUMes
81   [12] https://nlnet.nl/project/GNUMes-arm
82
83 * Legalese
84 Copyright © 2016,2017,2018,2019 Jan (janneke) Nieuwenhuizen <[[mailto:janneke@gnu.org][janneke@gnu.org]]>
85
86   Copying and distribution of this file, with or without modification,
87   are permitted in any medium without royalty provided the copyright
88   notice and this notice are preserved.