diff options
-rw-r--r-- | README.md | 44 | ||||
-rw-r--r-- | README.rst | 52 | ||||
-rw-r--r-- | lps_gen.py | 2 |
3 files changed, 53 insertions, 45 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index cf832f9..0000000 --- a/README.md +++ /dev/null @@ -1,44 +0,0 @@ -# LibrePlanet schedule generator - -## Get it - - $ git clone https://notabug.org/rsd/lpschedule-generator.git - -## Setup virtual environment - -Install `virtualenv` and `python-dev` package. - -On a Debian based distribution, do: - - # aptitude install virtualenv python-dev - - $ cd path/to/lpschedule-generator - $ virtualenv . - -## Activate virtual environment - - $ cd path/to/lpschedule-generator - $ source bin/activate - -Heads up! Always activate the virtual environment before executing any -of the commands in the following sections. - -## Install script - - $ python setup.py install - -This will install the script. - -## Upgrade script - - $ git pull origin master - $ python setup.py install - -## Usage - - $ lps_gen YEAR path/to/lp-schd.md > path/to/program-schedule.html - -Replace `YEAR` with LP year; for example, for generating LP 2016 -schedule, the command will be: - - $ lps_gen 2016 path/to/lp-schd.md > path/to/program-schedule.html diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..98388eb --- /dev/null +++ b/README.rst @@ -0,0 +1,52 @@ +LibrePlanet schedule generator +============================== + +Get it +------ + +Install `virtualenv` and `python-dev` package. + +On a Debian based distribution, do:: + + # aptitude install virtualenv python-dev + + $ cd path/to/lpschedule-generator + $ virtualenv . + +Activate virtual environment +---------------------------- + +:: + + $ cd path/to/lpschedule-generator + $ source bin/activate + +Heads up! Always activate the virtual environment before executing any +of the commands in the following sections. + +Install script +-------------- + +:: + + $ python setup.py install + +Upgrade script +-------------- + +:: + + $ git pull origin master + $ python setup.py install + +Usage +----- + +:: + + $ lps_gen YEAR path/to/lp-schd.md > path/to/program-schedule.html + +Replace `YEAR` with LP year; for example, for generating LP 2016 +schedule, the command will be:: + + $ lps_gen 2016 path/to/lp-schd.md > path/to/program-schedule.html @@ -30,7 +30,7 @@ from jinja2 import Environment, PackageLoader from jinja2.exceptions import TemplateNotFound from mistune import Renderer, Markdown -__version__ = '0.1.0.dev2' +__version__ = '0.1.0.dev3' # unicode magic reload(sys) |