summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorrsiddharth <rsd@gnu.org>2016-02-07 14:57:50 -0500
committerrsiddharth <rsd@gnu.org>2016-02-07 14:57:50 -0500
commit44ca000546fc24f9d83e2d03c8363d2105148612 (patch)
tree9ee4a2d40520e0303823852b0ba3250dfcdf1320 /README.rst
parenta9dffe7cdbb66ac047e599aec4692a1d6edf4e6a (diff)
updated README.rst
- Updated the lps_gen command to generate LP schedule (under Usage). - Added Special cases section (for LP schedule).
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst37
1 files changed, 32 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 47ce430..d8289bd 100644
--- a/README.rst
+++ b/README.rst
@@ -42,16 +42,22 @@ command::
$ source bin/activate
-Usage
------
+LP schedule
+-----------
+Usage
+~~~~~
::
- $ lps_gen path/to/lp-sch.jinja2 path/to/lp-sch.md > path/to/program-schedule.html
+ $ lps_gen -s path/to/lp-sch.jinja2 path/to/lp-sch.md > path/to/program-schedule.html
+
+or::
+
+ $ lps_gen --schedule path/to/lp-sch.jinja2 path/to/lp-sch.md > path/to/program-schedule.html
LP schedule markdown structure
-------------------------------
+``````````````````````````````
Overall structure::
@@ -115,9 +121,30 @@ Session structure::
[sandler]: https://libreplanet.org/YEAR/path/to/speakers.html#sandler
[sfc]: https://sfconservancy.org/
-
Sample: https://notabug.org/rsd/lpschedule-generator/raw/master/tests/files/lp-sch.md
+Special cases
++++++++++++++
+
+Room TBA
+........
+
+
+When a room for a session is not yet available put ``RoomTBA`` as the
+placeholder in the line that usually contains the room number; the
+rendered HTML will not have the room number for sessions that have
+``RoomTBA``.
+
+
+Sessions only schedule
+......................
+
+It is possible to have a sessions only schedule. To do this, at the
+beginning of the markdown document:
+
+ - Add a level two heading (``##``) with one or more whitespaces.
+ - Add a level three heading (``###``) with one or more whitespaces.
+
Sessions only sample: https://notabug.org/rsd/lpschedule-generator/raw/master/tests/files/lp-sch-sessions-only.md
Source