Update README with github actions info
This commit is contained in:
Thom Wiggers
förälder
462c7971d8
incheckning
f9f50ebc0d
91
.github/workflows/BADGES.md
vendored
Normal file
91
.github/workflows/BADGES.md
vendored
Normal file
@ -0,0 +1,91 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
9
.github/workflows/generate_workflows.py
vendored
9
.github/workflows/generate_workflows.py
vendored
@ -18,6 +18,10 @@ def render_workflow(scheme_path):
|
||||
if not TEST_MODE:
|
||||
with open(target_name, "w") as f:
|
||||
f.write(new_contents)
|
||||
with open("BADGES.md", "a") as f:
|
||||
f.write(
|
||||
f"![Test {scheme_name}]"
|
||||
f"(https://github.com/PQClean/PQClean/workflows/Test%20{scheme_name}/badge.svg?branch=master)\n")
|
||||
else:
|
||||
if (Path(".") / target_name).exists():
|
||||
with open(target_name, "r") as f:
|
||||
@ -42,6 +46,11 @@ if __name__ == "__main__":
|
||||
TPL_ENV = jinja2.Environment(
|
||||
loader=loader, variable_start_string="{-", variable_end_string="-}"
|
||||
)
|
||||
|
||||
if not TEST_MODE:
|
||||
with open("BADGES.md", "w") as f:
|
||||
f.truncate()
|
||||
|
||||
with open("template.yml.j2") as f:
|
||||
TEMPLATE = f.read()
|
||||
root = Path("../..")
|
||||
|
||||
100
README.md
100
README.md
@ -1,9 +1,97 @@
|
||||
# PQClean
|
||||
|
||||
[](https://travis-ci.com/PQClean/PQClean)
|
||||
[](https://ci.appveyor.com/project/PQClean/pqclean/branch/master)
|
||||
[](https://circleci.com/gh/PQClean/PQClean/tree/master)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**PQClean**, in short, is an effort to collect **clean** implementations of the post-quantum
|
||||
schemes that are in the
|
||||
[NIST post-quantum project](https://csrc.nist.gov/projects/post-quantum-cryptography).
|
||||
@ -161,10 +249,10 @@ All other code in this repository is released under the conditions of [CC0](http
|
||||
|
||||
See https://github.com/PQClean/PQClean/wiki/Test-framework for details about the PQClean test framework.
|
||||
|
||||
While we run extensive automatic testing on [Circle CI][circleci-pqc] (Linux builds), [Travis CI][travis-pqc] (OS X builds) and [Appveyor][appveyor-pqc] (Windows builds), most tests can also be run locally.
|
||||
While we run extensive automatic testing on Github Actions ((emulated) Linux builds, MacOS and Windows builds) and [Travis CI][travis-pqc] (Aarch64 builds), and most tests can also be run locally.
|
||||
To do this, make sure the following is installed:
|
||||
|
||||
* Python 3.5+
|
||||
* Python 3.6+
|
||||
* `pytest` for python 3.
|
||||
|
||||
We also recommend installing ``pytest-xdist`` to allow running tests in parallel.
|
||||
@ -179,6 +267,4 @@ Run the Python-based tests by going into the `test` directory and running `pytes
|
||||
|
||||
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/
|
||||
[travis-pqc]: https://travis-ci.com/PQClean/PQClean/
|
||||
[appveyor-pqc]: https://ci.appveyor.com/project/PQClean/pqclean
|
||||
|
||||
Laddar…
Referens i nytt ärende
Block a user