summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Ipsum <richardipsum@fastmail.co.uk>2015-07-19 12:49:17 +0100
committerLars Wirzenius <liw@liw.fi>2015-10-19 21:33:55 +0300
commit5f1da1126eee0c3326c194b38d88197c821fafe9 (patch)
tree79282e7c0caeb34bf277b4eee9832b197a217c61
parent9a927f9575f233e047300b9efa2b0b19bd55e854 (diff)
downloadobnam-5f1da1126eee0c3326c194b38d88197c821fafe9.tar.gz
Add INSTALL and note test requirements in README
-rw-r--r--INSTALL10
-rw-r--r--README7
2 files changed, 17 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 00000000..674d1ed2
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,10 @@
+INSTALL
+=======
+
+To install cliapp from source with pip you can run,
+
+$ pip install .
+
+cliapp also uses the 'meliae' python memory usage analyzer
+which can be obtained from https://launchpad.net/meliae.
+meliae is also packaged in debian as 'python-meliae'.
diff --git a/README b/README
index 62032740..f06dcd98 100644
--- a/README
+++ b/README
@@ -144,6 +144,13 @@ requests, and other feedback. I prefer e-mail the mailing list: see
It would be helpful if you can run `make clean check` before submitting
a patch, but it is not strictly required.
+Note that to run the test suite you will need the following installed:
+
+* pep8
+* coverage
+* CoverageTestRunner ( http://liw.fi/coverage-test-runner/ )
+ (python-coverage-test-runner on Debian)
+
Legal stuff
-----------