pqc/README.md

28 lines
598 B
Markdown

# Fun C implementation of NTRUEncrypt
Don't use this for any serious purpose, really. This is a fun
implementation with the primary goal of learning.
## Building
### Dependencies
* FLINT (compiled with gmp and mpfr)
* glib-2.0
* pkgconfig (for the build only)
### Compiling the library
Run ```make``` to build.
### Installing the library
Run ```make install``` to install.
### Building the documentation
Run ```make doc ```. The result will be in the doxygen/html/ subfolder.
### Build Status
[![Build Status](https://travis-ci.org/hasufell/pqc.png)](https://travis-ci.org/hasufell/pqc)