From c5e4bfc789e531f1a5fee3051948f702643b44fc Mon Sep 17 00:00:00 2001 From: Ralph Marschall Date: Tue, 14 Jan 2020 15:04:49 +0100 Subject: [PATCH] Add README.md --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b107192 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# BnL Quality Control Tool + +This project is the initial QA tool that has been developed at the BnL in 2014 and is still in use for current digitization compaigns. +However, the software is not actively developed. Only severe bug fixes are being made. The last major update was in 2018. + +The software is written in C++ and consist of 3 programs: + +* `loadinventory`: Load an external inventory file. +* `metsverifier`: Verifies a batch containing METS/ALTO packages. +* `namalysator`: GUI for quality control. + +## Features + +* BNL Inventory loading +* METS/ALTO validation against BnL Schema +* Various logical checks (Page numbers, inventory cross-validation) +* GUI with calendar view, document listing, error listing and document viewer. +* Error reporting and exporting + + +# Dependencies / Requirements + +* Windows 7 or later +* Visual Studio (recommended) +* QT 4.x (to be compiled from sources) +* Other C++ libraries might have to be compiled from source as well (Xalan, Xerces, Boost) + +*Note:* + +To compile this project, several paths linked to `C:\` might have to be updated for your local development environment.