diff options
Diffstat (limited to 'README.txt')
| -rw-r--r-- | README.txt | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..80614de --- /dev/null +++ b/README.txt @@ -0,0 +1,10 @@ +ZAP + +This repository contains the standard paper (stdzap), the official, "optimised" implementation (zap), and the official reference implementation (zapx). + +# Building and installation + +zap uses GNU Make for building: +The default target builds the static library file (located at 'zap/libzapq.a'). The target 'clean' removes object files, whilst 'purge' removes all artefacts. +Currently, zap doesn't support being compiled as a shared library out of the box, but the makefile could be modified to allow this. +The 'install' target installs the headers to '$(HDRDIR)' and the library file to '$(LIBDIR)'. Both values need to be set when invoking the makefile (like via `make HDRDIR=/usr/include LIBDIR=/usr/lib`), or by modifying the makefiles directly. |