From f6da18bdfd6f2f4fbc1f0500122472ca1215605b Mon Sep 17 00:00:00 2001 From: Andreas Romeyke <art1@andreas-romeyke.de> Date: Mon, 25 Oct 2021 17:26:57 +0200 Subject: [PATCH] - updated --- README.md | 62 +++++++------------------------------------------------ 1 file changed, 7 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 580efa7..c138fa9 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ NOTE: The use of option `copy` is strongly recommended. The remaining options mo ## Support ### Supported Operating Systems -* Debian 10 +* Debian 11 * Windows 10 ### Supported Versions @@ -16,7 +16,7 @@ NOTE: The use of option `copy` is strongly recommended. The remaining options mo ## Installation (Releases) -###Debian 10 +###Debian 11 1. Update system packages (optional but recommended): `sudo apt update && sudo apt upgrade -y` 2. Install required tools and libraries: @@ -52,56 +52,9 @@ NOTE: The use of option `copy` is strongly recommended. The remaining options mo → Try an example command from below `perl bin\slubsipbuilderbagit.pl`... -## Development -This guide will help you run (unreleased) development versions provided in this repository. -Please note, only release builds are supported and will have version or release date information. - -###Debian 10 -1. Update system packages (optional but recommended): - `sudo apt update && sudo apt upgrade -y` -2. Install required tools and libraries: - `sudo apt install -y build-essential git perl libperl-dev liblwp-protocol-https-perl libfile-copy-recursive-perl libmarc-record-perl libxml-libxml-perl libxml-xpath-perl libdatetime-format-iso8601-perl cpanminus` - `sudo cpanm Archive::BagIt` -3. Clone SLUB SIP Builder repository: - `git clone https://git.slub-dresden.de/digital-preservation/SLUB_SIP_Builder.git` - `cd SLUB_SIP_Builder` - → Hint: For simple updates at a later date, just use `git pull` in directory `SLUB_SIP_Builder` to get the latest version. -4. Checkout the desired branch/tag/commit: - → for example most current master - `git checkout master` -4. Run unit tests (optional): - `perl t/slubsipbuilderbagit.t` -5. Run SLUB SIP Builder: - → Try an example command from below - `perl bin/slubsipbuilderbagit.pl`... - -### Windows 10 -1. Check UTF-8 flag at [ENG] `Systemadministration/TimeAndRegion/Region/Administration/AreaPattern` or [DE] `Systemsteuerung/Zeit und Region/Region/Verwaltung/Gebietsschema ändern/`, for using such characters as `äöüÄÖÜß`. Computer will be restarted! -2. Download strawberry perl environment [strawberry-perl-5.30.3.1-64bit-portable](https://strawberryperl.com/releases.html) -3. Extract files from archive -4. Download [Archive::BagIt](https://metacpan.org/pod/Archive::BagIt) module (Example: Archive-BagIt-0.074.tar.gz) -5. Start strawberry perl console `portableshell.bat` - 1. Unpack archive `tar zxf Archive-BagIt-0.074.tar.gz` for example in the same dir where strawberryperl extracted - 2. Change dir `cd Archive-BagIt-0.074` - 3. Generate Makefile `perl Makefile.pl` - 4. Run `gmake`, than `gmake install` - 5. Check if module installed `cpanm Archive::BagIt`. At this point Archive::BagIt module installed. - 6. Change dir back `cd ..` -6. Install additional libraries: - `cpanm MARC::Record XML::XPath DateTime::Format::ISO8601 Win32::Console::ANSI` -7. Clone SLUB SIP Builder repository: - `git clone https://git.slub-dresden.de/digital-preservation/SLUB_SIP_Builder.git` - `cd SLUB_SIP_Builder` - → Hint: For simple updates at a later date, just use `git pull` in directory `SLUB_SIP_Builder` to get the latest version. -8. Run unit tests (optional): - `perl t\slubsipbuilderbagit.t` -9. Run SLUB SIP Builder: - → Try an example command from below - `perl bin\slubsipbuilderbagit.pl`... - ## Building Releases -### Debian 10 +### Debian 11 1. Check external dependencies: → i.e. Appropriate rights schema version included? 2. Build ZIP archive with release version: @@ -141,7 +94,6 @@ Usage: -SIP_output_path=<target dir> where to put the SIP dir (absolute path!) -ppn=<ppn>|-noppn=<noppn> SWB-PPN or any identifier (uses minimalistic marc21) - -SIP_version=<version> mandatory, needs for identification of SIP format, supported <v2020.1> -external_workflow=<workflow> mandatory, should be uniqe workflow name -external_id=<id> mandatory, should be uniqe ID (i.e. a catalog ID), reuse an ID only when updating existing AIP -external_ISIL=<isil> optional, ISIL number of library @@ -169,7 +121,7 @@ EXAMPLES Copy (minimalistic) perl bin/slubsipbuilderbagit.pl --save_option=copy --IE_directory=/IE/git/SLUB_SIP_Builder/export_dir_kitodo/bagit/test2 - --SIP_output_path=/output_sips --ppn=457035137 --SIP_version=v2020.1 + --SIP_output_path=/output_sips --ppn=457035137 --external_id=10008 --external_workflow=kitodo --external_ISIL=DE-14 --external_value_descr="Gesetzlicher Auftrag" --rights_version=1.0 --rights_xml=/metadata/rights/Fallbeispiel-02.xml @@ -177,7 +129,7 @@ EXAMPLES Copy perl bin/slubsipbuilderbagit.pl --save_option=copy --IE_directory=/IE/git/SLUB_SIP_Builder/export_dir_kitodo/bagit/test2 - --SIP_output_path=/output_sips --ppn=457035137 --SIP_version=v2020.1 + --SIP_output_path=/output_sips --ppn=457035137 --external_id=10008 --external_workflow=kitodo --external_ISIL=DE-14 --external_value_descr="Gesetzlicher Auftrag" --rights_version=1.0 --rights_xml=/metadata/rights/Fallbeispiel-01.xml @@ -191,7 +143,7 @@ EXAMPLES perl bin/slubsipbuilderbagit.pl --save_option=replace --IE_directory=/IE/SLUB_SIP_Builder/export_dir_kitodo/bagit/test2 - --ppn=457035137 --SIP_version=v2020.1 --external_id=10008 + --ppn=457035137 --external_id=10008 --external_workflow=kitodo --external_ISIL=DE-14 --external_value_descr="Gesetzlicher Auftrag" --rights_version=1.0 --rights_xml=/metadata/rights/Fallbeispiel-01.xml @@ -202,7 +154,7 @@ EXAMPLES perl bin/slubsipbuilderbagit.pl --save_option=move --IE_directory=/IE/git/SLUB_SIP_Builder/export_dir_kitodo/bagit/test2 - --SIP_output_path=/output_sips --ppn=457035137 --SIP_version=v2020.1 + --SIP_output_path=/output_sips --ppn=457035137 --external_id=10008 --external_workflow=kitodo --external_ISIL=DE-14 --external_value_descr="Gesetzlicher Auftrag" --rights_version=1.0 --rights_xml=/metadata/rights/Fallbeispiel-03.xml -- GitLab