From 0aa204c04288fc1793754b8b6d0afba13ab49a53 Mon Sep 17 00:00:00 2001 From: Matt Mascarenhas Date: Thu, 22 Jun 2017 23:11:01 +0100 Subject: [PATCH] README.md: Tweak fair warning and formatting [#26] --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a453719..4a8526d 100644 --- a/README.md +++ b/README.md @@ -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: