diff options
| author | Kartik Agaram <vc@akkartik.com> | 2020-07-05 15:28:37 -0700 |
|---|---|---|
| committer | Kartik Agaram <vc@akkartik.com> | 2020-07-06 01:05:10 -0700 |
| commit | 9a524793ee01ce47f3963768559a0d6c348631c5 (patch) | |
| tree | aa1045424609f1a14a7a8e5bfaa1517101acd894 /bootstrap.md | |
| parent | 3ccb2c83280e22ad5b7f7c47d7bd95748b969521 (diff) | |
| download | mu-9a524793ee01ce47f3963768559a0d6c348631c5.tar.gz | |
6618 - new docs
Diffstat (limited to 'bootstrap.md')
| -rw-r--r-- | bootstrap.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/bootstrap.md b/bootstrap.md new file mode 100644 index 00000000..ca9320e5 --- /dev/null +++ b/bootstrap.md @@ -0,0 +1,17 @@ +## 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. |