Skip to content
Snippets Groups Projects
Commit 9ab93379 authored by bolkun's avatar bolkun
Browse files

update README.md 10

parent 82a84c1b
No related branches found
No related tags found
No related merge requests found
...@@ -7,7 +7,7 @@ This options are based on payload files, which would be saved in data directory ...@@ -7,7 +7,7 @@ This options are based on payload files, which would be saved in data directory
NOTE: use option `copy` if you are not sure how to restore your payload files, when something goes wrong! NOTE: use option `copy` if you are not sure how to restore your payload files, when something goes wrong!
## Operating Systems ## 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 äöüÄÖÜß) * Windows 10 (NOTE: check if UTF-8 flag set at `Systemadministration/TimeAndRegion/Region/Administration/AreaPattern`, if you want to use such characters as äöüÄÖÜß)
* Debian 10 * Debian 10
## Requirements ## Requirements
...@@ -16,7 +16,7 @@ NOTE: use option `copy` if you are not sure how to restore your payload files, w ...@@ -16,7 +16,7 @@ NOTE: use option `copy` if you are not sure how to restore your payload files, w
## Three ways to install a module ## Three ways to install a module
* with cpan `cpan Archive::BagIt` * with cpan `cpan Archive::BagIt`
* with cpanm `cpanm Archive::BagIt` (Note: `cpan App::cpanminus` must be installed). To force installation run `cpanm -i -f Archive::BagIt`. * with cpanm `cpanm Archive::BagIt` (NOTE: `cpan App::cpanminus` must be installed). To force installation run `cpanm -i -f Archive::BagIt`.
* manual as downloaded package * manual as downloaded package
1. Download for example Archive-BagIt-0.065.tar.gz from [metacpan Archive::BagIt](https://metacpan.org/pod/Archive::BagIt) 1. Download for example Archive-BagIt-0.065.tar.gz from [metacpan Archive::BagIt](https://metacpan.org/pod/Archive::BagIt)
2. Extract it with `tar zxf Archive-BagIt-0.065.tar.gz` and go to project dir with `cd in Archive-BagIt-0.065` 2. Extract it with `tar zxf Archive-BagIt-0.065.tar.gz` and go to project dir with `cd in Archive-BagIt-0.065`
...@@ -31,7 +31,7 @@ NOTE: use option `copy` if you are not sure how to restore your payload files, w ...@@ -31,7 +31,7 @@ NOTE: use option `copy` if you are not sure how to restore your payload files, w
2. Run `cpanm --uninstall Archive::BagIt` 2. Run `cpanm --uninstall Archive::BagIt`
## Documentation ## Documentation
* Recommanded Windows 10 perl environment [strawberry-perl-5.30.3.1-64bit-portable](http://strawberryperl.com/releases.html) * RECOMMANDED: Windows 10 perl environment [strawberry-perl-5.30.3.1-64bit-portable](http://strawberryperl.com/releases.html)
* Project based on BagIt 1.0 specification, visit [RFC8493](https://tools.ietf.org/html/rfc8493) * Project based on BagIt 1.0 specification, visit [RFC8493](https://tools.ietf.org/html/rfc8493)
* Some valid Bag examples based on operation system look at `export_dir_kitodo/bagit/lin_*` or `export_dir_kitodo/bagit/win_*` * Some valid Bag examples based on operation system look at `export_dir_kitodo/bagit/lin_*` or `export_dir_kitodo/bagit/win_*`
* Specification of creating a SLUB SIP you can find at [SLUBArchiv_Produzenten_SIP_Spezifikation.pdf](https://slubarchiv.slub-dresden.de/technische-standards-fuer-die-ablieferung-von-digitalen-dokumenten/) * Specification of creating a SLUB SIP you can find at [SLUBArchiv_Produzenten_SIP_Spezifikation.pdf](https://slubarchiv.slub-dresden.de/technische-standards-fuer-die-ablieferung-von-digitalen-dokumenten/)
...@@ -76,7 +76,7 @@ Options: ...@@ -76,7 +76,7 @@ Options:
perl -I lib/ bin/slubsipbuilderbagit.pl -man perl -I lib/ bin/slubsipbuilderbagit.pl -man
``` ```
###### Result ###### Result
* Note: Write command in one line. * MUST: Write command in one line.
```perl ```perl
EXAMPLES EXAMPLES
Copy (minimalistic) Copy (minimalistic)
...@@ -123,7 +123,7 @@ EXAMPLES ...@@ -123,7 +123,7 @@ EXAMPLES
##### Tests ##### Tests
* Start scipt in project directory to run all tests properly. * Start scipt in project directory to run all tests properly.
* Note: while running tests path `tmp/bagit` will be created. * NOTE: while running tests path `tmp/bagit` will be created.
```perl ```perl
perl -I lib/ t/slubsipbuilderbagit.t perl -I lib/ t/slubsipbuilderbagit.t
``` ```
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment