From 347217ba137929f51127ea8e427f11d18c02e81b Mon Sep 17 00:00:00 2001 From: Thom Wiggers Date: Fri, 5 Apr 2019 10:42:14 +0200 Subject: [PATCH] Mention submodules in README --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6936d629..c055e9f4 100644 --- a/README.md +++ b/README.md @@ -139,10 +139,16 @@ To do this, make sure the following is installed: * Python 3.5+ * `nosetests` or `nose2` (either for Python 3) +You will also need to make sure the submodules are initialized by running: + +``` +git submodule update --init +``` + Run the Python-based tests by going into the `test` directory and running `nosetests -v` or `nose2 -B -v`, depending on what you installed. If you have the `rednose` plugin for `nosetests` installed, run `nosetests --rednose` to get colored output. -You may also run `python ` where `` is any of the files starting with `test_` in the `test/` folder. +You may also run `python3 ` where `` is any of the files starting with `test_` in the `test/` folder. [circleci-pqc]: https://circleci.com/gh/PQClean/PQClean/ [travis-pqc]: https://travis-ci.com/PQClean/PQClean/