Annotation-Pushers
/
Annotation-System
1
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

README.md: Tweak fair warning and formatting [#26]

This commit is contained in:
Matt Mascarenhas 2017-06-22 23:11:01 +01:00
parent 716e694ccd
commit 0aa204c042
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,4 +1,5 @@
Fair warning: This is all under development and not production ready
Fair warning: This is all under development and not yet packaged up for easy
deployment
## hmml_to_html
@ -21,7 +22,7 @@ This outputs a binary `hmml_to_html`
This simply generates an HTML file (and updates `cinera_topics.css` if needed)
from `test.hmml` and outputs to `out.html`
Note that if the .hmml file contains quotes (as `test.hmml` does), it would be
Note that if the `.hmml` file contains quotes (as `test.hmml` does), it would be
easiest for now just to remove the quote from `test.hmml`. If you want quotes
to work, run:
@ -37,10 +38,10 @@ may want to remove / comment out
CINERA_MODE=INTEGRATE ./hmml_to_html test.hmml
This will integrate into template.html (currently hardcoded) the player and
related elements generated from test.hmml and output to out.html
This will integrate into `template.html` (currently hardcoded) the player and
related elements generated from `test.hmml` and output to `out.html`
Feel free to play with template.html to your heart's content. If you do
Feel free to play with `template.html` to your heart's content. If you do
anything invalid, `hmml_to_html` will tell you what's wrong
Valid tags: