diff --git a/README.md b/README.md
index e5b1b86..c61ab13 100644
--- a/README.md
+++ b/README.md
@@ -1,81 +1,125 @@
Fair warning: This is all under development and not yet packaged up for easy
deployment
-## hmml_to_html
+## cinera
### Download, and prepare the parser
1. `git clone git@gitssh.handmade.network:Annotation-Pushers/Annotation-System.git`
2. `cd Annotation-System/hmmlib`
3. `make`
-4. `cp hmml.a hmmlib.h ../hmml_to_html/`
-5. `cd ../hmml_to_html/`
+4. `cp hmml.a hmmlib.h ../cinera/`
+5. `cd ../cinera/`
Note: For each parser update, remember to make and copy it into place
### Build
-1. `zsh hmml_to_html.c` (replacing zsh with your shell as appropriate)
+1. `zsh cinera.c` (replacing zsh with your shell as appropriate)
### Run
-#### Ordinary operation
+#### Single Edition operation
- ./hmml_to_html test.hmml
+ cinera test.hmml
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
-easiest for now just to remove the quote from `test.hmml`. If you want quotes
-to work, run:
+#### Project Edition operation
- mkdir /home/matt/git/GitHub/insofaras/25fc16d58a297a486334
- git clone https://gist.github.com/insofaras/25fc16d58a297a486334 /home/matt/git/GitHub/insofaras/25fc16d58a297a486334
+ cinera -p ProjectID
- (Seriously, the path is hardcoded for now)
+Setting the ProjectID with the `-p` flag triggers Project Edition. In this
+edition `cinera` monitors the Project Input Directory for new, edited and
+deleted .hmml files, and generates one table of contents / search page and a
+player page each for valid sets of annotations (or removes them, if needed).
-Note also that `cinera.css` contains a `body {}` block at the bottom which you
-may want to remove / comment out
+By default all directories - input and output - are set to the current working
+directory. Typical operation will involve setting these flags:
+
+ -d Project Input Directory, the directory where the .hmml files reside
+ -r Root Directory, path shallower than or equal to the CSS, Images and JS
+ directories
+ -u Root URL, corresponding to the Root Directory (optional if the Output
+ Base Directory resides in the Root Directory)
+ -b Output Base Directory, location of the table of contents / search page
+ -t Player Template Location
+ -x Index Template Location
#### Integration
- CINERA_MODE=INTEGRATE ./hmml_to_html test.hmml
+ CINERA_MODE=INTEGRATE cinera 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_player.html` (configurable with -t) the
+player and related elements generated from `test.hmml` and output to
+`out_integrated.html`
-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
+Feel free to play with `template_player.html` to your heart's content. If you do
+anything invalid, `cinera` will tell you what's wrong
+
+#### Templates
Valid tags:
- `` _the day / episode name, intended to be used
inside your own `
` element, but may be used wherever and as many times
as you want on your page_
+
+*Index Template*
+- `` _the necessary `.css` and `.js` files_
+- `` _the table of contents, and search functionality_
+
+*Player Template*
- `` _the necessary `.css` and `.js` files, and charset setting_
-- `` _ _the menu bar that typically appears above the
- player in my samples_
+- `` _ _the menu bar that typically appears above the player in my samples_
- `` _the player_
-- `` _the listeners that enable interaction with the player_
+- `` _the filter state objects and `.js` file, which must come after both the MENUS and PLAYER tags_
#### Arguments
- Usage: ./hmml_to_html [option(s)] filename(s)
+ Usage: ./cinera [option(s)] filename(s)
Options:
- -c
- Override default CSS directory (".")
- -i
- Override default images directory (".")
- -j
- Override default JS directory (".")
- -o