summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt11
1 files changed, 4 insertions, 7 deletions
diff --git a/README.txt b/README.txt
index 80614de..894c6b3 100644
--- a/README.txt
+++ b/README.txt
@@ -1,10 +1,7 @@
-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:
+zap uses GNU Make as the build system. The library is primarily written in GNU Assembly (with preprocessing required), with some modules still being written in C90.
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.
+When invoking the makefile, the arch variable must be set (currently, the only allowed value is 'amd64'). This can be set when at invocation (like via `make arch=amd64`), or by modifying the makefile directly.
+Currently, zap doesn't support being compiled as a shared library by default, but the makefile could be modified to allow this.
+The 'install' target installs the headers to HDRDIR and the library file to LIBDIR.