From 49cfc3d77da9ba56081191076369d3a277d037f0 Mon Sep 17 00:00:00 2001
From: Andreas Romeyke <art1@andreas-romeyke.de>
Date: Thu, 28 Oct 2021 13:56:10 +0200
Subject: [PATCH] - reenabled dev instructions - fixed Archive::BagIt
installation, only use CPAN!
---
README.md | 61 ++++++++++++++++++++++++++++++++++++++++++-------------
1 file changed, 47 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index c138fa9..5c9a6c2 100644
--- a/README.md
+++ b/README.md
@@ -32,23 +32,56 @@ NOTE: The use of option `copy` is strongly recommended. The remaining options mo
###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)
+2. Download strawberry perl environment [strawberry-perl-5.32.1.1-64bit-portable](https://strawberryperl.com/releases.html)
3. Extract files from archive
-4. Download [Archive::BagIt](https://metacpan.org/pod/Archive::BagIt) library (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` (alternative: 7-zip, if tar is not available)
- 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. Download the latest [Release](https://git.slub-dresden.de/digital-preservation/SLUB_SIP_Builder/-/releases):
+4. Start strawberry perl console `portableshell.bat`
+5Install additional libraries:
+ `cpanm MARC::Record XML::XPath DateTime::Format::ISO8601 Win32::Console::ANSI Archive::BagIt`
+6.Download the latest [Release](https://git.slub-dresden.de/digital-preservation/SLUB_SIP_Builder/-/releases):
→ ZIP file like `SLUB_SIP_Builder.version-XYZ-master.zip`
-8. Extract the ZIP archive and change into the project directory:
+7.Extract the ZIP archive and change into the project directory:
`cd SLUB_SIP_Builder`
-9. Run SLUB SIP Builder:
+8.Run SLUB SIP Builder:
+ → 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 11
+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.32.1.1-64bit-portable](https://strawberryperl.com/releases.html)
+3. Extract files from archive
+4. Start strawberry perl console `portableshell.bat`
+5 . Install additional libraries:
+ `cpanm MARC::Record XML::XPath DateTime::Format::ISO8601 Win32::Console::ANSI Archive::BagIt`
+6.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.
+7.Run unit tests (optional):
+ `perl t\slubsipbuilderbagit.t`
+8.Run SLUB SIP Builder:
→ Try an example command from below
`perl bin\slubsipbuilderbagit.pl`...
--
GitLab