summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorrsiddharth <rsd@gnu.org>2015-12-19 18:39:03 -0500
committerrsiddharth <rsd@gnu.org>2015-12-19 18:39:03 -0500
commitb5c721876d7e241c7e5b4955b04ad9ea185698ad (patch)
treecfaa63271685c8f3b8e0fbc4d2d91d50ebf7ee9e
parent8bbbd13d95825e2b5590cf17f2829115e7537684 (diff)
Updated README.md
-rw-r--r--README.md38
1 files changed, 27 insertions, 11 deletions
diff --git a/README.md b/README.md
index ff61a14..cf832f9 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,44 @@
# LibrePlanet schedule generator
-## On GNU/Linux
+## Get it
-Install `virtualenv` and python dev. package.
+ $ 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
-## Set up environment
+ $ cd path/to/lpschedule-generator
+ $ virtualenv .
- $ git clone git://notabug.org/rsd/lpschedule-generator.git
+## Activate virtual environment
-Setup virtual environment:
+ $ cd path/to/lpschedule-generator
+ $ source bin/activate
- $ cd lpschedule-generator
- $ virtualenv .
+Heads up! Always activate the virtual environment before executing any
+of the commands in the following sections.
-Activate the virtual environment:
+## Install script
- $ source bin/activate
+ $ python setup.py install
+
+This will install the script.
-Install `lpschedule-generator`:
+## Upgrade script
+ $ git pull origin master
$ python setup.py install
-This will install all the dependencies.
+## 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