changeset 17:678278cb85b1

Add installation steps in README.
author Ludovic Chabant <ludovic@chabant.com>
date Mon, 30 Jul 2018 18:19:04 -0700
parents 025e6a5bb5a3
children a921cc2306bc
files README.rst
diffstat 1 files changed, 17 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.rst	Mon Jul 30 00:00:30 2018 -0700
+++ b/README.rst	Mon Jul 30 18:19:04 2018 -0700
@@ -24,6 +24,23 @@
 - Print: a debug silo that just prints entries in the console.
 
 
+Installation
+------------
+
+You can install SiloRider like any other Python tool::
+
+  pip install silorider
+
+You can then check it installed correctly with::
+
+  silorider -h
+
+You can also install from source by cloning the Git or Mercurial repository and
+running::
+
+  pip install -e /path/to/silorider/repo
+
+
 Quickstart
 ----------