pqc/README.md

29 lines
636 B
Markdown
Raw Normal View History

2014-05-28 19:25:52 +00:00
# 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.
2014-06-05 16:37:43 +00:00
## Building
### Dependencies
2014-05-28 19:25:52 +00:00
* FLINT (compiled with gmp and mpfr)
* glib-2.0
* lz4 (https://code.google.com/p/lz4)
2014-06-05 16:15:42 +00:00
* pkgconfig (for the build only)
2014-05-28 19:25:52 +00:00
2014-06-05 16:37:43 +00:00
### Compiling the library
2014-05-28 19:25:52 +00:00
2014-05-28 19:31:12 +00:00
Run ```make``` to build.
2014-05-30 23:24:43 +00:00
2014-06-05 16:37:43 +00:00
### Installing the library
Run ```make install``` to install.
2014-06-05 16:35:06 +00:00
### Building the documentation
Run ```make doc ```. The result will be in the doxygen/html/ subfolder.
2014-05-30 23:24:43 +00:00
### Build Status
[![Build Status](https://travis-ci.org/hasufell/pqc.png)](https://travis-ci.org/hasufell/pqc)