From 2b26ce7a290292af1dad27a0cfdc4ae7c4094ca2 Mon Sep 17 00:00:00 2001
From: Richard Nias <nias-r@users.noreply.github.com>
Date: Sun, 19 Nov 2017 21:42:00 +0000
Subject: [PATCH] Add extra documentation covering environment variables and
 running tests (#226)

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index 0c8ee93a..7d472f18 100644
--- a/README.md
+++ b/README.md
@@ -492,10 +492,27 @@ pip install -r requirements.txt
 At this point your virtual environment should have everything it needs to run both the sample `project` and
 `silk` successfully.
 
+Before running, you must set the `DB` and `DB_NAME` environment variables:
+
+```bash
+export DB=sqlite3
+export DB_NAME=db.sqlite3
+```
+
+For other combinations, check [`.travis.yml`](./.travis.yml).
+
 Now from the root of the sample `project` directory start the django server
 
 ```bash
 python manage.py runserver
 ```
 
+#### Running the tests
+
+```bash
+cd project
+./tests/test_migrations.sh
+python manage.py test --noinput
+```
+
 Happy profiling!