Documentation update.
[mes.git] / README
1                                                               -*- org -*-
2 Mes -- Maxwell Equations of Software
3
4 Mes aims to create an entirely source-based bootstrapping path.  The
5 target is to [have GuixSD] boostrap from a minimal, easily inspectable
6 binary --that should be readable as source-- into something close to
7 R6RS Scheme.
8
9 As bootstrapping is presumably easiest and probably most fun with
10 Scheme, the next step for Mes is mescc: a C compiler/linker to
11 boostrap into GNU Gcc and GNU Guile, possibly via Tiny-CC.
12
13 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
14 McCarthy page 13.
15
16 Mes is free software, it is distributed unde the terms of the GNU
17 General Public Licence version 3 or later.  See the file COPYING.
18
19 * Get it
20
21    git clone https://gitlab.com/janneke/mes
22
23 * Build it (see INSTALL for full instructions)
24
25    ./configure
26    make all
27    make check
28
29 * REPL it
30
31    scripts/repl.mes
32
33 * Mescc compiler
34
35    scripts/mescc.mes doc/examples/main.c