diff --git a/README.md b/README.md index 42a0703ac4d6ff4f4e6dd7ad2371b9e40743ce46..fbeaa94a707f077f11332f905b7a2b3b50044187 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,7 @@ NOTE: The use of option `copy` is strongly recommended. The remaining options mo ## Supported Operating Systems * Debian 10 -* Windows 10 -NOTE: check UTF-8 flag at [ENG]`Systemadministration/TimeAndRegion/Region/Administration/AreaPattern` or [DE]`Systemsteuerung/Zeit und Region/Region/Verwaltung/Gebietsschema ändern/`, if you want to use such characters as `äöüÄÖÜß` +* Windows 10 RECOMMENDED: strawberry perl environment [strawberry-perl-5.30.3.1-64bit-portable](http://strawberryperl.com/releases.html). It includes `cpanm` with many preinstalled CPAN modules. ## Requirements @@ -39,6 +38,29 @@ Using cpanm is recommended for an assisted and clean uninstall. * install cpanm with `cpan App::cpanminus`. * remove a Perl module with `cpanm --uninstall MODULE_NAME` +## Installation (Win 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.072.tar.gz) +5. Start strawberry perl console `portableshell.bat` + 1. Unpack archive `tar zxf Archive-BagIt-0.072.tar.gz` for example in the same dir where strawberryperl extracted + 2. Change dir `cd Archive-BagIt-0.072` + 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. Download [SLUB_SIP_Builder](https://git.slub-dresden.de/digital-preservation/SLUB_SIP_Builder) as zip +7. Extract files from archive +8. Change console path to extracted SLUB_SIP_Builder +9. Run tests `perl t/slubsipbuilderbagit.t` or `prove.t` and errors will come like 'Can't locate MARC/Record.pm in @INC (you may need to install the `MARC::Record` module) ...' +10. Copy from error module name and install it, repeat point 9 and 10 till test process starts. + * `cpanm MARC::Record` + * `cpanm XML::XPath` + * `cpanm DateTime::Format::ISO8601` +11. All tests must process successfully and you are ready to go with Bag creation +12. If colors on console not visible, than add line `use Win32::Console::ANSI` in file `SLUB_SIP-Builder/bin/slubsipbuilderbagit.pl` above `use Term::ANSIColor;` + * `cpanm Win32::Console::ANSI` + ## Documentation * Project based on BagIt 1.0 specification, visit [RFC8493](https://tools.ietf.org/html/rfc8493) * For valid SIP examples based on operating system please have a look at `export_dir_kitodo/bagit/lin_*` or `export_dir_kitodo/bagit/win_*`