crc/retroforth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add BUILDING overview document

Browse source 
FossilOrigin-Name: 16f0af806d67d782752c51932b0f5c8891ae278d587de93796ea0aca43735d0d
This commit is contained in:
crc 2022-01-07 14:20:16 +00:00
parent 41089951f9
commit 332cf1a4a2
1 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
BUILDING.md Normal file
View file

@ -0,0 +1,32 @@
# Building RetroForth
This is a quick overview of how to build Retro on a BSD, Linux,
or macOS system. It assumes you already have the requirements
(c compiler, make) setup in your command line environment.
## Standard Builds
A standard build should just require running `make`:
make
This will build the toolchain and a binary runtime for retro.
These will be placed in the `bin` directory.
## Customized Builds
The basic system provides most of the functionality, but you
can enable or disable specific elements by editing either
the Makefile (on BSD) or GNUmakefile (or Linux or macOS).
Find the fourth section in the Makefile and either uncomment
or comment the ENABLED and DEVICES lines for the optional parts
you want to include in your build.
Most functionality is enabled by default. Optional things you
may wish to enable include sockets, ffi, and multicore.
## More Complex Customizations
There are additional things you can update. Take a look in the
manual for more tedails on this.