summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Maw <richard.maw@codethink.co.uk>2015-09-04 17:09:20 +0000
committerRichard Maw <richard.maw@codethink.co.uk>2015-09-04 17:09:20 +0000
commit45407215f72e8fcde72a793fcc9083483c1136da (patch)
treeec4ef4bd21179d00db0e233b88d2056e48f3848c
parent1562d2704feed51a4b4909c29b9f697a37185dc0 (diff)
downloadfirehose-45407215f72e8fcde72a793fcc9083483c1136da.tar.gz
Include installation gummage in README
-rw-r--r--README33
1 files changed, 33 insertions, 0 deletions
diff --git a/README b/README
index d22719b..9112c65 100644
--- a/README
+++ b/README
@@ -20,3 +20,36 @@ Debian Version Comparison
The `debian/` directory contains a subset of the `python-debian` module which
is under the GPL and has its authors listed in the files themselves.
+
+Installing firehose
+===================
+
+Install non-packaged components:
+
+ $ mkdir ~/src
+ $ git clone -b baserock/richardmaw/wip git://git.baserock.org/baserock/baserock/firehose.git ~/src/firehose
+ $ git clone -b baserock/morph git://git.baserock.org/delta/cliapp.git ~/src/cliapp
+ $ git clone git://git.baserock.org/baserock/baserock/morph.git ~/src/morph
+ $ install -D -m755 /dev/stdin ~/bin/morph <<'EOF'
+ > #!/bin/sh
+ > BASE="$HOME/src/morph"
+ > PYTHONPATH="${BASE}${PYTHONPATH:+:${PYTHONPATH}}"
+ > export PYTHONPATH
+ > exec "$BASE/morph" "$@"
+ > EOF
+ $ SITE="$(python -m site --user-site)"
+ $ mkdir -p "$SITE"
+ $ ln -s ~/src/cliapp/cliapp "$SITE"
+ $ ln -s ~/src/morph/morphlib "$SITE"
+
+Install pip packaged dependencies:
+
+ $ pip install --user fs pylru
+
+Set trove config
+
+ $ install -D -m644 /dev/stdin ~/.morph.conf <<'EOF'
+ > [config]
+ > trove-id = cu010-trove
+ > trove-host = cu010-trove.codethink.com
+ > EOF