From 98a6f2cf3803fba2af8068140640378896129d1f Mon Sep 17 00:00:00 2001 From: Thom Wiggers Date: Thu, 28 Feb 2019 17:00:57 +0100 Subject: [PATCH] Add remark about running astyle to contributing See #60 --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2cf23fb3..265c3ef4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,6 +44,10 @@ See the section [API](#API) below. 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). + 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. * We suggest you copy these from `crypto_kem/kyber768/clean` and modify them to suit your scheme.