diff options
author | Kartik K. Agaram <vc@akkartik.com> | 2021-03-09 00:41:26 -0800 |
---|---|---|
committer | Kartik K. Agaram <vc@akkartik.com> | 2021-03-09 00:41:26 -0800 |
commit | 9586db164cb80f2344f96b0af8a180ff4f50f2bb (patch) | |
tree | a31cd0a248b7e73d652967a99b9aecc047dc0cdf | |
parent | a77643c66a28bd633ee78ade65a83d2c95ea1835 (diff) | |
download | mu-9586db164cb80f2344f96b0af8a180ff4f50f2bb.tar.gz |
make the library reference easier to find
-rw-r--r-- | README.md | 34 | ||||
-rw-r--r-- | linux/README.md | 3 |
2 files changed, 20 insertions, 17 deletions
diff --git a/README.md b/README.md index d747c094..4abf4891 100644 --- a/README.md +++ b/README.md @@ -134,7 +134,12 @@ Here's an example program in Mu: <img alt='ex2.mu' src='html/ex2.mu.png' width='400px'> -[More details on Mu syntax →](mu.md) +More resources on Mu: + +* [Mu Syntax reference](mu.md) + +* [Library reference.](vocabulary.md) Mu programs can transparently call + low-level functions written in SubX. Here's an example program in SubX: @@ -149,7 +154,17 @@ Entry: e8/call syscall_exit/disp32 ``` -[More details on SubX syntax →](subx.md) +More resources on SubX: + +* [SubX syntax reference](subx.md) + +* [Some starter exercises for learning SubX](https://github.com/akkartik/mu/pulls) + (labelled `hello`). Feel free to [ping me](mailto:ak@akkartik.com) with any + questions. + +* The [list of x86 opcodes](subx_opcodes) supported in SubX: `linux/bootstrap/bootstrap help opcodes`. + +* [Some tips for debugging SubX programs.](subx_debugging.md) ## Forks @@ -174,8 +189,7 @@ pull your changes into this repo! If you're still reading, here are some more things to check out: -- The references on [Mu](mu.md) and [SubX](subx.md) syntax, and also [bare - SubX](subx_bare.md) without any syntax sugar. +- [How to get your text editor set up for Mu and SubX programs.](editor/editor.md) - [Some 2-minute videos demonstrating Mu programs](https://archive.org/details/@kartik_agaram). Many of them involve this prototype live-updating programming environment @@ -187,24 +201,12 @@ If you're still reading, here are some more things to check out: $ ./a.elf screen ``` -- [How to get your text editor set up for Mu and SubX programs.](editor/editor.md) - -- [Some tips for debugging SubX programs.](subx_debugging.md) - -- [Shared vocabulary of data types and functions shared by Mu programs.](vocabulary.md) - Mu programs can transparently call low-level functions written in SubX. - - [A summary](mu_instructions) of how the Mu compiler translates statements to SubX. Most Mu statements map to a single x86 instruction. ([colorized version](http://akkartik.github.io/mu/html/mu_instructions.html)) -- [Some starter exercises for learning SubX](https://github.com/akkartik/mu/pulls) - (labelled `hello`). Feel free to [ping me](mailto:ak@akkartik.com) with any questions. - - [Commandline reference for the bootstrap C++ program.](bootstrap.md) -- The [list of x86 opcodes](subx_opcodes) supported in SubX: `linux/bootstrap/bootstrap help opcodes`. - - [Some details on the unconventional organization of this project.](http://akkartik.name/post/four-repos) - Previous prototypes: [mu0](https://github.com/akkartik/mu0), [mu1](https://github.com/akkartik/mu1). diff --git a/linux/README.md b/linux/README.md index a1fe2820..8b81a386 100644 --- a/linux/README.md +++ b/linux/README.md @@ -32,7 +32,8 @@ The Mu compiler toolchain is also here in the following phases: * Bare SubX: `hex`, `survey_elf`, `pack`, `dquotes`, `assort`, `tests` * Syntax sugar for SubX: `sigils`, `calls`, `braces` -* Mu->SubX compiler: `mu` +* Mu->SubX compiler: `mu`. Compiles [most statements](http://akkartik.github.io/mu/html/mu_instructions.html) + to a single instruction of machine code. The toolchain includes binaries in the repo. At any commit, the binary should be identical bit for bit with the result of translating the corresponding |