about summary refs log tree commit diff stats
path: root/linux/browse/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'linux/browse/README.md')
-rw-r--r--linux/browse/README.md21
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.