diff options
author | Kartik K. Agaram <vc@akkartik.com> | 2021-03-03 22:09:50 -0800 |
---|---|---|
committer | Kartik K. Agaram <vc@akkartik.com> | 2021-03-03 22:21:03 -0800 |
commit | 71e4f3812982dba2efb471283d310224e8db363e (patch) | |
tree | ea111a1acb8b8845dbda39c0e1b4bac1d198143b /linux/browse/README.md | |
parent | c6b928be29ac8cdb4e4d6e1eaa20420ff03e5a4c (diff) | |
download | mu-71e4f3812982dba2efb471283d310224e8db363e.tar.gz |
7842 - new directory organization
Baremetal is now the default build target and therefore has its sources at the top-level. Baremetal programs build using the phase-2 Mu toolchain that requires a Linux kernel. This phase-2 codebase which used to be at the top-level is now under the linux/ directory. Finally, the phase-2 toolchain, while self-hosting, has a way to bootstrap from a C implementation, which is now stored in linux/bootstrap. The bootstrap C implementation uses some literate programming tools that are now in linux/bootstrap/tools. So the whole thing has gotten inverted. Each directory should build one artifact and include the main sources (along with standard library). Tools used for building it are relegated to sub-directories, even though those tools are often useful in their own right, and have had lots of interesting programs written using them. A couple of things have gotten dropped in this process: - I had old ways to run on just a Linux kernel, or with a Soso kernel. No more. - I had some old tooling for running a single test at the cursor. I haven't used that lately. Maybe I'll bring it back one day. The reorg isn't done yet. Still to do: - redo documentation everywhere. All the README files, all other markdown, particularly vocabulary.md. - clean up how-to-run comments at the start of programs everywhere - rethink what to do with the html/ directory. Do we even want to keep supporting it? In spite of these shortcomings, all the scripts at the top-level, linux/ and linux/bootstrap are working. The names of the scripts also feel reasonable. This is a good milestone to take stock at.
Diffstat (limited to 'linux/browse/README.md')
-rw-r--r-- | linux/browse/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/linux/browse/README.md b/linux/browse/README.md new file mode 100644 index 00000000..8f92b584 --- /dev/null +++ b/linux/browse/README.md @@ -0,0 +1,21 @@ +Render a subset of Markdown. + +To run: + + ``` + $ ./translate_mu apps/browse.mu + $ ./a.elf __text_file__ + ``` + +Press 'q' to quit. All other keys scroll down. + +## Format restrictions + +This is a fairly tiny subset of GitHub-Flavored Markdown. Things supported so +far: + +* Newlines are mostly ignored. Double newlines are rendered (paragraphs). + Newlines followed by indentation are rendered. +* Paragraphs starting with runs of `#` represent headings. +* Within a line, characters between `*`s or `_`s represent bolded text. No + italics. |