summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2013-11-15 14:25:45 +0000
committerLars Wirzenius <liw@liw.fi>2013-11-15 14:25:45 +0000
commitb64f4810bbe24c0384535afb202d6c2bd2ee6214 (patch)
treebf5a01b796ce5162bdfa60411b666f862b8f78a0
parent2bfb8683c316b201f3d19de3a9fa54eecfa7d551 (diff)
downloadcmdtest-b64f4810bbe24c0384535afb202d6c2bd2ee6214.tar.gz
Add installation instructions to README.yarn
Suggested-by: David Harrison
-rw-r--r--README.yarn20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.yarn b/README.yarn
index 16f7522..5f1c7a2 100644
--- a/README.yarn
+++ b/README.yarn
@@ -1,6 +1,26 @@
README for yarn, a scenario testing tool
========================================
+Installation
+------------
+
+* You need Python 2. Yarn's dependencies do not work with Python 3.
+ (Yet.)
+* Install ttystatus: <http://git.liw.fi/cgi-bin/cgit/cgit.cgi/ttystatus>
+* Install cliapp: <http://git.liw.fi/cgi-bin/cgit/cgit.cgi/cliapp>
+* Install Python-Markdown:
+ <http://github.com/waylan/Python-Markdown.git>
+* You can install them from source, or using your operating system's
+ package manager (if they've been packaged for your operating system;
+ Debian has them: `python-ttystatus`, `python-cliapp`,
+ `python-markdown`).
+* Similarly, install yarn from source or with the package manager
+ (in Debian: `cmdtest`).
+* Installation from source requires cloning the git repository and
+ running `python setup.py install`, perhaps with additional options
+ (see `--help`) to specify installation location, etc. Read also the
+ installation documentation of the libraries.
+
Introduction
------------