Go to file
hasufell e4bdeb1e79
DOC: fix doxygen comments
2014-09-13 18:26:47 +02:00
include DOC: minor fixes 2014-06-28 13:11:36 +02:00
src DOC: fix doxygen comments 2014-09-13 18:26:47 +02:00
tests BUILD: update PHONY 2014-06-28 02:13:21 +02:00
.gitignore TESTS: initial test suite implementation 2014-06-28 00:54:55 +02:00
.travis.yml TRAVIS: try to fix make check 2014-06-28 01:21:09 +02:00
COPYING LICENSE: add LGPL-2.1 license file 2014-04-14 23:58:19 +02:00
HACKING.md DOC: add Hacking guide 2014-06-22 22:40:44 +02:00
Makefile TESTS: initial test suite implementation 2014-06-28 00:54:55 +02:00
README.md DOC: add doxygen to deps 2014-06-28 13:03:40 +02:00
common.mk PUB-API: rename the headers, install them in ntru/ subfolder 2014-06-09 00:10:39 +02:00
update-gh-pages.sh DOC: run doxygen separately for internal/external API 2014-06-09 02:11:52 +02:00

README.md

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
  • lz4 (https://code.google.com/p/lz4)
  • cunit (for the tests only)
  • doxygen (for the documentation only)
  • pkgconfig (for the build only)

Compiling the library

Run make to build.

Running the tests

Run make check to run the test suite.

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