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

Add remark about running astyle to contributing

Browse Source 
See #60
This commit is contained in:
Thom Wiggers 2019-02-28 17:00:57 +01:00
parent e39dec0919
commit 98a6f2cf38
No known key found for this signature in database
GPG Key ID: 001BB0A7CE26E363
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -44,6 +44,10 @@ See the section [API](#API) below.
1. Make sure all symbols are prefixed with `PQCLEAN_YOURSCHEME_CLEAN_`. 1. Make sure all symbols are prefixed with `PQCLEAN_YOURSCHEME_CLEAN_`.
2. Include `api.h` into your scheme with the symbols specified in the section [API](#API). 2. Include `api.h` into your scheme with the symbols specified in the section [API](#API).
3. We use `astyle` to format code. You may consider running the following command on your submission:
```
astyle --project crypto_kem/yourschemename/clean/*.[ch]
```
5. Create `Makefile` and `Makefile.Microsoft_nmake` files to compile your scheme as static library. 5. Create `Makefile` and `Makefile.Microsoft_nmake` files to compile your scheme as static library.
* We suggest you copy these from `crypto_kem/kyber768/clean` and modify them to suit your scheme. * We suggest you copy these from `crypto_kem/kyber768/clean` and modify them to suit your scheme.