lpschedule-generator

libreplanet schedule generator - ricketyspace.net/lpschedule-generator
git clone git://git.ricketyspace.net/lpschedule-generator.git
Log | Files | Refs

commit bef9fee1ec5e5c0c5435f12e18bf95345ae1e965
parent c5a383b4902ae6a370060b47bde9f9e73d20b7e2
Author: rsiddharth <rsd@gnu.org>
Date:   Fri, 13 May 2016 16:36:51 +0000

update docs/install/index.rst

Diffstat:
docs/install/index.rst | 54++++++++++++++++++++++++++++++++++++++++++++++++++----
1 file changed, 50 insertions(+), 4 deletions(-)

diff --git a/docs/install/index.rst b/docs/install/index.rst @@ -1,9 +1,16 @@ +.. highlight:: shell + Installation ------------ On a Debian based distribution, do:: - # aptitude install virtualenv python-setuptools + $ sudo apt-get install python-pip + +On GNU Guix, do:: + + $ guix package -i python-pip + Install globally ~~~~~~~~~~~~~~~~ @@ -13,8 +20,18 @@ Install globally $ sudo pip install lpschedule-generator -Install locally using virtualenv (Recommended) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Install locally using virtualenv +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +First get ``virtualenv``. + +On a Debian based distribution, do:: + + $ sudo apt-get install virtualenv + +On GNU Guix, do:: + + $ guix package -i python-virtualenv Make a separate ``lpschedule-generator`` directory and initialize the virtual environment in it:: @@ -22,7 +39,7 @@ virtual environment in it:: $ mkdir lpschedule-generator $ cd lpschedule-generator - $ virtualenv . + $ virtualenv -p python2.7 . $ source bin/activate Install ``lpschedule-generator`` inside this directory using ``pip``:: @@ -37,3 +54,32 @@ command:: $ cd path/to/lpschedule-generator $ source bin/activate + + +Test +~~~~ + +Do:: + + $ lps_gen --help + +.. highlight:: text + +You must get:: + + usage: lps_gen [-h] [-s | -sp] [--ical ICAL] [--version] lp_t lp_md + + positional arguments: + lp_t Path to the LP template. + lp_md Path to the LP markdown. + + optional arguments: + -h, --help show this help message and exit + -s, --schedule Generate LP schedule + -sp, --speakers Generate LP speakers + --ical ICAL Specify LP year as argument; generates iCal + --version Show version number and exit. + +If the ``lps_gen`` command is installed, move to the :ref:`next +section <lps-doc-sec-schedule>`; otherwise for +:ref:`lps-doc-sec-help`.