From 63d66ba20a634b54f6d5e8b051fb4a106f2cef6c Mon Sep 17 00:00:00 2001
From: John Newbery <john@johnnewbery.com>
Date: Wed, 8 Mar 2017 17:46:18 -0500
Subject: Move src/test/bitcoin-util-test.py to test/util/bitcoin-util-test.py

---
 test/README.md | 60 ++++++++++++++++++++++++++++++++++------------------------
 1 file changed, 35 insertions(+), 25 deletions(-)

(limited to 'test/README.md')

diff --git a/test/README.md b/test/README.md
index 3bf43717fc..dec8db960d 100644
--- a/test/README.md
+++ b/test/README.md
@@ -1,29 +1,32 @@
-The [functional](/test/functional/) folder contains a script test_runner
- to call multiple functional tests from its folder.
+This directory contains integration tests that test bitcoind and its
+utilities in their entirety. It does not contain unit tests, which
+can be found in [/src/test](/src/test), [/src/wallet/test](/src/wallet/test),
+etc.
 
-Every pull request to the bitcoin repository is built and run through
-the regression test suite. You can also run all or only individual
-tests locally.
+There are currently two sets of tests in this directory:
 
-Test dependencies
-=================
-Before running the tests, the following must be installed.
+- [functional](/test/functional) which test the functionality of 
+bitcoind and bitcoin-qt by interacting with them through the RPC and P2P
+interfaces.
+- [util](test/util) which tests the bitcoin utilities, currently only
+bitcoin-tx.
 
-Unix
-----
-The python3-zmq library is required. On Ubuntu or Debian it can be installed via:
-```
-sudo apt-get install python3-zmq
-```
+The util tests are run as part of `make check` target. The functional
+tests are run by the travis continuous build process whenever a pull
+request is opened. Both sets of tests can also be run locally.
 
-OS X
-------
-```
-pip3 install pyzmq
-```
+Functional Test dependencies
+============================
+The ZMQ functional test requires a python ZMQ library. To install it:
+
+- on Unix, run `sudo apt-get install python3-zmq`
+- on mac OS, run `pip3 install pyzmq`
 
-Running tests
-=============
+Running tests locally
+=====================
+
+Functional tests
+----------------
 
 You can run any single test by calling
 
@@ -80,8 +83,15 @@ rm -rf cache
 killall bitcoind
 ```
 
-Writing tests
-=============
-You are encouraged to write tests for new or existing features.
-Further information about the test framework and individual functional
+Util tests
+----------
+
+Util tests can be run locally by running `test/util/bitcoin-util-test.py`. 
+Use the `-v` option for verbose output.
+
+Writing functional tests
+========================
+
+You are encouraged to write functional tests for new or existing features.
+Further information about the functional test framework and individual 
 tests is found in [test/functional](/test/functional).
-- 
cgit v1.2.3