Merge pull request #5 from zanebeckwith/simulator-in-readme

Add a note about running the simulator for running tests, in the README.
xaptum · Dec 22, 2017 · b466e04 · b466e04
2 parents 6962cc2 + fb2d5a4
commit b466e04
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -21,7 +21,15 @@ cmake --build . -- -j4
 ```
 
 ## Running the tests
+The tests assume that a TPM2.0 simulator (for instance, [IBM's simulator](https://sourceforge.net/projects/ibmswtpm2/))
+is listening locally on TCP port 2321.
+This can be achieved by running the following in the background, before starting the tests:
+```
+.travis/install-ibm-tpm2.sh
+.travis/run-ibm-tpm2.sh
+```
 
+Then, to run the test suite:
 ```bash
 cd build
 ctest -V