diff options
Diffstat (limited to 'linux/bootstrap/README.md')
| -rw-r--r-- | linux/bootstrap/README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/linux/bootstrap/README.md b/linux/bootstrap/README.md index ca4ea4b3..dcf1f79d 100644 --- a/linux/bootstrap/README.md +++ b/linux/bootstrap/README.md @@ -7,3 +7,21 @@ b) A second translator for SubX programs that emits identical binaries to the self-hosting versions in the parent directory. Having two diverse compilers (one in a familiar language, one with minimal syscall surface area) that emit identical binaries should help gain confidence in Mu. + +## Running + +`bootstrap` currently has the following sub-commands: + +- `bootstrap help`: some helpful documentation to have at your fingertips. + +- `bootstrap test`: runs all automated tests. + +- `bootstrap translate <input files> -o <output ELF binary>`: translates `.subx` + files into an executable ELF binary. + +- `bootstrap run <ELF binary> <args>`: simulates running the ELF binaries emitted + by `bootstrap translate`. Useful for testing and debugging. + + Remember, not all 32-bit Linux binaries are guaranteed to run. I'm not + building general infrastructure here for all of the x86 instruction set. + SubX is about programming with a small, regular subset of 32-bit x86. |