From 007d19d2b6f42f29c94d24de06dd8c079823f984 Mon Sep 17 00:00:00 2001
From: rachmadani haryono <rachmadaniHaryono@users.noreply.github.com>
Date: Thu, 10 Aug 2017 10:51:30 +0800
Subject: [PATCH] add test documentation (#181)

* new: doc: running test

* chg: doc: add to toc
---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index 9b1202e..12db3d1 100644
--- a/README.md
+++ b/README.md
@@ -38,6 +38,7 @@
 - [Mentions](#mentions)
 - [Examples](#examples)
 - [Third-party integration](#third-party-integration)
+- [Running tests](#running-tests)
 - [Collaborators](#collaborators)
 
 ### Introduction
@@ -569,6 +570,29 @@ for resp, url in zip(gr_results, urls):
 
         echo $1 | buku -a
 
+### Running tests
+
+We use [tox](http://readthedocs.org/docs/tox/) to manage virtualenvs and run tests.
+Alternatively, tests can be run using [detox](https://pypi.python.org/pypi/detox/) which allows for running tests in parallel
+
+        $ pip install tox detox
+
+Run all of the tests with:
+        $ tox
+
+Run all of the tests in parallel with detox:
+
+        $ detox
+
+If you running into this error check you buku setting.
+
+```
+>       self.assertEqual(dbdir_local_expected, BukuDb.get_default_dbdir())
+E       AssertionError: '/home/user/.local/share/buku' != '/home/user/projects/buku'
+E       - /home/user/.local/share/buku
+E       + /home/user/projects/buku
+```
+
 ### Collaborators
 
 - [Arun Prakash Jana](https://github.com/jarun)