andrius
/
M2-Planet
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixing of ommissions provided by akkartik

This commit is contained in:
Jeremiah Orians 2018-08-31 16:11:00 -04:00
parent 6ea629f6a2
commit 42914441c3
No known key found for this signature in database
GPG Key ID: 7457821534D2ACCD
2 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
HACKING
View File

@ -1,16 +1,13 @@
-*-mode:org-*-
M2-Planet being based on the goal of bootstrapping the Minimal C compiler required to support structs, arrays, inline assembly and self hosting;
M2-Planet being based on the goal of bootstrapping the Minimal C compiler
required to support structs, arrays, inline assembly and self hosting;
is rather small, under 1.7Kloc according to sloccount
* SETUP
The most obvious way to setup for M2-Planet development is to clone and setup mescc-tools first (https://github.com/oriansj/mescc-tools.git)
Then be sure to install any C compiler and make clone of your choice.
Should you wish to verify or leverage the M2-Moon bootstrap path;
please make sure to setup M2-Moon (https://github.com/oriansj/M2-Moon.git)
and then setup the knight-vm (https://github.com/oriansj/knight-vm.git)
* BUILD
The standard C based approach to building M2-Planet is simply running:
make M2-Planet
@ -19,11 +16,16 @@ Should you wish to verify that M2-Planet was built correctly run:
make test
* ROADMAP
The current outstanding work for M2-Planet involves porting M2-Planet into M2-Moon and extending its functionality
M2-Planet V1.0 is the bedrock of all future M2-Planet versions. Any future
release that will depend upon a more advanced version to be compiled, will
require the version prior to it to be named V2.0 and the same properties apply
To all future release of M2-Planet. All minor releases are buildable by the last
major release and All major releases are buildable by the last major release.
* DEBUG
To get a properly debuggable binary:
make M2-Planet-gcc
To get a properly debuggable binary: make M2-Planet-gcc
However if you are comfortable with gdb, knowing that function names are
prefixed with FUNCTION_ the M2-Planet binary is quite debuggable.
* Bugs
M2-Planet assumes a very heavily restricted subset of the C language and many C

11
INSTALL
View File

@ -5,10 +5,17 @@ Building and Installing M2-Planet
* Prerequisites
** Bootstrapping
M2-Planet will be bootstrappable by M2-Moon and mescc-tools
M2-Planet will be bootstrappable by stage0
(https://git.savannah.nongnu.org/git/stage0.git)
and mescc-tools (https://git.savannah.nongnu.org/git/mescc-tools.git)
** Development
The tools required for easier development include binutils, gcc and make; along with the above bootstrapping programs
The tools required for easier development include binutils, gcc and make;
along with the above bootstrapping programs
** Dependencies
M2-Planet depends upon mescc-tools to convert the files it outputs into working
binaries and for it to build itself
* Build it
make