diff --git a/README b/README index 0b2cc8912c3730af5961ac3d76eaf5497e51a5f1..1442aa45f303525f8b89738b5f5d98eafade4a49 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. +