From 54bfee1de27fd9783dc594aea31e03a405ae7b8c Mon Sep 17 00:00:00 2001 From: Samuel Lampa Date: Wed, 2 Sep 2015 17:11:32 +0200 Subject: [PATCH] Update README with Prerequisites and Install sections --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 0466ccb..14f69ec 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,31 @@ class MyWorkflow(sl.WorkflowTask): That's it! And again, see the "usage" section just below for a more detailed description of getting to this! +## Prerequisites + +- Python 2.7 - 2.x (No Python 3.x support) +- Luigi 1.3.x + +## Install + +1. Install luigi, preferrably through PyPI: + ```bash + pip install luigi + ``` +2. Clone the sciluigi library + ```bash + cd + git clone https://github.com/samuell/sciluigi.git + git checkout tags/v0.9 # Check out the 0.9 version + ``` +3. Now you can use the library by just importing it in your python script, like so: + ```python + import sciluigi + ``` + Note that you can aliase it to a shorter name, for brevity, and to save keystrokes: + ```python + import sciluigi as sl + ``` ## Usage