diff options
| author | rsiddharth <rsd@gnu.org> | 2015-12-20 00:28:38 -0500 |
|---|---|---|
| committer | rsiddharth <rsd@gnu.org> | 2015-12-20 00:28:38 -0500 |
| commit | fc4103c24b70980870475faa09b8a130174ddcf3 (patch) | |
| tree | 5bd223f90ef5817b047b89da4909752e3bb013bf /README.rst | |
| parent | 70d886e741d18a5829b801a991867cd1a5f60adb (diff) | |
updated README.rst
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 48 |
1 files changed, 21 insertions, 27 deletions
@@ -1,43 +1,29 @@ LibrePlanet schedule generator ============================== -Get it ------- - -Install ``virtualenv`` and ``python-dev`` package. +Installation +------------ On a Debian based distribution, do:: - # aptitude install virtualenv python-dev + # aptitude install virtualenv python-setuptools - $ cd path/to/lpschedule-generator + $ mkdir lpschedule-generator $ virtualenv . + $ source bin/activate -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. + $ pip install lpschedule-generator --pre -Install script --------------- - -:: - $ python setup.py install +Activating virtual environment +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Upgrade script --------------- +Always activate the virtual environment before using the ``lps_gen`` +command:: -:: + $ cd path/to/lpschedule-generator + $ source bin/activate - $ git pull origin master - $ python setup.py install Usage ----- @@ -46,7 +32,15 @@ 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 +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 + + +Source +------ + +:: + + $ git clone https://notabug.org/rsd/lpschedule-generator.git |