Skip to content
Snippets Groups Projects
Commit c69e7350 authored by Jens Steidl's avatar Jens Steidl :baby_chick:
Browse files

- updated README

parent 7b80b449
No related branches found
No related tags found
1 merge request!4Update README
......@@ -4,13 +4,13 @@
A CLI tool to create valid [BagIt](https://tools.ietf.org/html/rfc8493) based submission information packages (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!
NOTE: The use of option `copy` is strongly recommended. The remaining options modify your source directory. Please use these with caution!
## Supported Operating Systems
* Debian 10
* Windows 10
(NOTE: check UTF-8 flag at `Systemadministration/TimeAndRegion/Region/Administration/AreaPattern`, if you want to use such characters as `äöüÄÖÜß`)
(NOTE: check UTF-8 flag at `Systemadministration/TimeAndRegion/Region/Administration/AreaPattern`,
if you want to use such special characters like umlauts `äöüÄÖÜß` in file paths)
## Requirements
* Perl version 5.28 or higher
......@@ -29,10 +29,10 @@ NOTE: The use of option `copy` is strongly recommended. The other options modify
6. `(d)gmake install`
7. with `cpanm Archive::BagIt` test for the version. Result will be something like `Archive::BagIt is up to date (0.067)`.
## Module deinstallation
## Perl module deinstallation
Using cpanm is recommended for an assisted and clean uninstall.
1. `cpan App::cpanminus` must be installed.
2. Run `cpanm --uninstall Archive::BagIt`
* install cpanm with `cpan App::cpanminus`.
* remove a Perl module with `cpanm --uninstall MODULE_NAME`
## Documentation
* RECOMMENDED for Windows 10: strawberry perl environment [strawberry-perl-5.30.3.1-64bit-portable](http://strawberryperl.com/releases.html)
......@@ -126,7 +126,7 @@ EXAMPLES
--rights_xml=/metadata/rights/Fallbeispiel-03.xml
```
##### Tests
##### Run tests
* Start script in project directory to run all tests properly.
* NOTE: while running tests path `tmp/bagit` will be created.
```perl
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment