From cddd4282032a71b7f2579813df59d1bd8eccbb51 Mon Sep 17 00:00:00 2001 From: Jens Steidl <Jens.Steidl@slub-dresden.de> Date: Thu, 15 Oct 2020 16:21:27 +0200 Subject: [PATCH] - updated description - added line breaks --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ed95e8d..5e2e150 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ # SLUB SIP Builder ## Description -A CLI tool to create a valid BagIt SIP for SLUBArchiv. -As a user, you have three options to create your SIP: `copy`, `move` or `replace`. -NOTE: The use of option `copy` is strongly recommended. The other options modify your source directory, please use this with caution! +A CLI tool to create valid BagIt-based SIPs for ingest into the [SLUBArchiv](https://slubarchiv.slub-dresden.de/), the digital long-term preservation archive of the Saxon State and University Library Dresden (SLUB). + +As a user, you have one of three options to create your SIP: `copy`, `move` or `replace`. +NOTE: The use of option `copy` is strongly recommended. The other options modify your source directory. Please use this with caution! ## Operating Systems * Windows 10 (NOTE: check if UTF-8 flag set at `Systemadministration/TimeAndRegion/Region/Administration/AreaPattern`, if you want to use such characters as äöüÄÖÜß) @@ -32,7 +33,7 @@ Using cpanm is recommended for an assisted and clean uninstall. 2. Run `cpanm --uninstall Archive::BagIt` ## Documentation -* RECOMMENDED for Windows 10: strawberry perl environment [strawberry-perl-5.30.3.1-64bit-portable](http://strawberryperl.com/releases.html) +* RECOMMENDED for Windows 10: strawberry perl environment [strawberry-perl-5.30.3.1-64bit-portable](http://strawberryperl.com/releases.html) (includes `cpanm` with many preinstalled CPAN modules) * 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_*` -- GitLab