From bab831d83955a43e60e6d181060c2d1032fccd39 Mon Sep 17 00:00:00 2001
From: Daniel <daniel@harvey>
Date: Fri, 5 Mar 2021 14:01:26 +0100
Subject: [PATCH] DOC: Requirements and certificate documentation.

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

diff --git a/README.md b/README.md
index 3a18809..d564155 100644
--- a/README.md
+++ b/README.md
@@ -18,12 +18,22 @@ CaosDB project.
 - If you want to run just a single test, you can also select a single test file:  
   `pytest-3 tests/test_issues.py`
 
+## Requirements ##
+
+- Running the tests needs `pytest`, obviously, and also the `nose` library:
+  - `pip3 install pytest nose`
+
 ## Run tests agains a remote caosdb server
 
 * There is a special mark `local_server`, which marks all test which cannot
   pass when the server is not on the host where the test suite is running.
 * Start tests with `pytest -m "not local_server"` or
   `tox -- -m "not local_server"`.
+* The remote caosdb server must have a TLS certificate which maches the name given in
+  `pycaosdb.ini`.  If you use the *LinkAhead* distribution of CaosDB, this can be achieved by:
+    * `linkahead cert_gen -- --hostname <your hostname>`
+    * `linkahead certs -d <your profile path>/custom/other/cert`
+    * `linkahead start`
 
 # Further Reading
 
-- 
GitLab