From 4320a4bb0a4af2f22a9bf8244bfca78465062d17 Mon Sep 17 00:00:00 2001
From: Gregory Ashton <gregory.ashton@ligo.org>
Date: Fri, 18 May 2018 13:27:25 +1000
Subject: [PATCH] Update readme

---
 README.md | 44 +++++++++++++++++++-------------------------
 1 file changed, 19 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index d53ab8384..8cd815249 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ https://monash.docs.ligo.org/tupak/)
 
 # Tupak
 
-Fulfilling all your GW dreams.
+Fulfilling all your gravitational wave dreams.
 
 ## Example
 
@@ -27,8 +27,10 @@ To get started with `tupak`, we have a few examples and tutorials:
 
 ## Installation
 
-In the following, we assume you have installed
-[https](pip://pypa.io.en/stable/installing/pip/) and [git](https://git-scm.com/).
+`tupak` is developed to work with both Python 2.7+ and Python 3+. In the
+following, we assume you have a working python installation, [python
+pip](https://packaging.python.org/tutorials/installing-packages/#use-pip-for-installing),
+and [git](https://git-scm.com/).
 
 ### Install tupak
 Clone the repository, install the requirements, and then install `tupak`.
@@ -39,12 +41,18 @@ $ pip install -r requirements.txt
 $ python setup.py install
 ```
 
-Once you have run these steps, you have `tupak` installed.
+Once you have run these steps, you have `tupak` installed. You can now try to
+run the examples. However, for many gravitational-wave related examples you'll
+also need to install `lalsuite`.
 
 ### Install lalsuite
-The simple way: `pip install lalsuite`, or,
-from source:
+We recommend you install `lalsuite` the simple way:
 
+```bash
+$ pip install lalsuite.
+```
+
+If this doesn't work, or you prefer to, you can also install from source.
 Head to
 [https://git.ligo.org/lscsoft/lalsuite](https://git.ligo.org/lscsoft/lalsuite)
 to check you have an account and SSH keys set up. Then,
@@ -61,32 +69,18 @@ $ make; make install
 Warning: in the configure line here, we have disabled everything except
 lalsimulation. If you need other modules, see `./configure --help`.
 
+### Install pymultinest
 
 If you want to use the `pymultinest` sampler, you first need the
 MultiNest library to be installed to work properly. The full instructions can
 be found [here](https://johannesbuchner.github.io/PyMultiNest/install.html). We
 have also written [a shortened tl;dr here](./TLDR_MULTINEST.md).
 
-## Tests and coverage
 
-To locally test the code
-
-```bash
-$ python tests.py
-```
-
-To locally generate a coverage report
-
-```bash
-$ pip install coverage
-$ coverage run tests.py
-$ coverage html
-```
-
-This will generate a directory `htmlcov`, to see detailed coverage navigate
-from your browser to the file `tupak/htmlcov/index.html`.
+## Tests and coverage
 
-The coverage report for master can be seen here:
-[https://monash.docs.ligo.org/tupak/](https://monash.docs.ligo.org/tupak/).
+We have a variety of tests which can be found in the `tests` directory.  You
+can find a [current coverage report for master
+here.](https://monash.docs.ligo.org/tupak/).
 
 
-- 
GitLab