From d300ed5d55f78824a5bcac622e20a5a7b8acd619 Mon Sep 17 00:00:00 2001
From: Pompolic <pompolic@special-circumstanc.es>
Date: Wed, 15 Apr 2020 14:52:10 +0200
Subject: [PATCH] Update build instructions and copyright notice
---
README | 27 ++++++++++++++++++++++++---
1 file changed, 24 insertions(+), 3 deletions(-)
diff --git a/README b/README
index 0b2cc89..1442aa4 100644
--- a/README
+++ b/README
@@ -5,15 +5,36 @@ Beginnings of a PDF parser in Hammer
https://gitlab.special-circumstanc.es/pesco/hammer/tree/pdf
+ For detailed build instructions, see README.md in that repository.
+
- Help the default Makefile find Hammer
- $ ln -s ../hammer/src hammer
- $ ln -s ../hammer/build/opt/src lib
+ $ ln -s ../hammer/src hammer # needed for building pdf, include files
+ $ ln -s ../hammer/build/opt/src lib # needed for running pdf, to locate libhammer.so
- Build/Usage:
-
+
+ $ pushd ../hammer; scons; popd # build Hammer
$ make pdf
$ ./pdf test.pdf
# place some test files in the t/ directory...
$ make test
+
+- Evaluating test results:
+
+ For every file in the t/ directory, the pdf parser is executed. On successful parse, a message of the following form is displayed:
+
+ OK: t/<filename>
+
+ On a failed test run, parse error messages are displayed.
+
+- Copyright:
+
+ - pesco 2019,2020
+ - pompolic 2020
+ - Paul Vines 2020
+ - David Bryant (modified lzw-ab code)
+
+ See LICENSE and lzw-ab-license.txt for full copyright and licensing notice.
+
--
GitLab