izaya/OC-MultICE
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated build instructions to reflect recent changes

Browse Source
This commit is contained in:
Izaya 2017-04-24 01:32:54 +10:00
parent 8955ee52c4
commit 09c5718a18
1 changed files with 7 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/build.md
View File

@ -1,22 +1,13 @@
# Building MultICE
MultICE uses a relatively simple build system. It has been tested on Arch Linux, Debian Linux, OpenOS and Plan9k.
## 1. Choose modules.
The system is made out of modules from the `modules/` directory. When you run the build script, it assembles them, and optionally optomises the code for space.
The system is made out of modules from the `modules/` directory. When you run the build script, it assembles them, and optionally optomises the code for space.
There are a number of preconfigured module sets in the `config/` directory, and you can of course you can write your own.
Modules are specified in the `modules.cfg` file and are relative to the `modules/` folder.
An example for interactive usage with networking:
```
base/header.lua
drivers/dterm.lua
library/print.lua
drivers/keyboard.lua
library/net.lua
applications/luash.lua
base/footer.lua
```
The build system defaults to a file called `modules.cfg` in the current directory. You can specify a config file using `--modconfig=file.cfg`.
## 2. Configure build system
The build system has a configuration file `build.cfg`.
### `optomise`
The build system has a configuration file `build.cfg`, though another can be specified using `--cfgfile=file.cfg`.
### `optimise`
Can either be yes or no.
Specifies whether to run the simple optimisation function on the kernel.
### `test`
@ -27,6 +18,8 @@ Can either be yes or no.
Specifies whether to output log files.
### `opath`
Specifies where to put the output kernel.
### `ospath`
Specifies where to put the output kernel after being optimised.
## 3. Build.
Simply run `build.lua`. Under OpenOS or plan9k that may just be going to the right dir and entering `build`, but under proper UNIX systems it may involve `lua build.lua`.