From b64f4810bbe24c0384535afb202d6c2bd2ee6214 Mon Sep 17 00:00:00 2001
From: Lars Wirzenius <liw@liw.fi>
Date: Fri, 15 Nov 2013 14:25:45 +0000
Subject: Add installation instructions to README.yarn

Suggested-by: David Harrison
---
 README.yarn | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'README.yarn')

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
 ------------
 
-- 
cgit v1.2.1