kris/pqc
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Mention submodules in README

Browse Source
This commit is contained in:
Thom Wiggers 2019-04-05 10:42:14 +02:00
parent dac0d96904
commit 347217ba13
No known key found for this signature in database
GPG Key ID: 001BB0A7CE26E363
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -139,10 +139,16 @@ To do this, make sure the following is installed:
* Python 3.5+ * Python 3.5+
* `nosetests` or `nose2` (either for Python 3) * `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. 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. If you have the `rednose` plugin for `nosetests` installed, run `nosetests --rednose` to get colored output.
You may also run `python <testmodule>` where `<testmodule>` is any of the files starting with `test_` in the `test/` folder. You may also run `python3 <testmodule>` where `<testmodule>` is any of the files starting with `test_` in the `test/` folder.
[circleci-pqc]: https://circleci.com/gh/PQClean/PQClean/ [circleci-pqc]: https://circleci.com/gh/PQClean/PQClean/
[travis-pqc]: https://travis-ci.com/PQClean/PQClean/ [travis-pqc]: https://travis-ci.com/PQClean/PQClean/