README

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