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

Updated README.md file

parent c69e7350
No related branches found
No related tags found
No related merge requests found
......@@ -9,8 +9,8 @@ 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 `Systemadministration/TimeAndRegion/Region/Administration/AreaPattern`,
if you want to use such special characters like umlauts `äöüÄÖÜß` in file paths)
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 `äöüÄÖÜß`
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
* Perl version 5.28 or higher
......@@ -19,15 +19,19 @@ if you want to use such special characters like umlauts `äöüÄÖÜß` in file
## Three ways to install a module
* with cpan `cpan Archive::BagIt`
* with cpanm `cpanm Archive::BagIt` (NOTE: `cpan App::cpanminus` must be installed).
* with cpanm `cpanm Archive::BagIt` (NOTE: `cpan App::cpanminus` must be installed. If errors like IO:AIO are present, use `cpanm -i -f Archive::BagIt`).
* from source (Linux)
1. Download for example Archive-BagIt-0.067.tar.gz from [metacpan Archive::BagIt](https://metacpan.org/pod/Archive::BagIt)
2. Extract it with `tar zxf Archive-BagIt-0.067.tar.gz` and go to project dir with `cd in Archive-BagIt-0.067`
1. Download for example Archive-BagIt-0.069.tar.gz from [metacpan Archive::BagIt](https://metacpan.org/pod/Archive::BagIt)
2. Extract it with `tar zxf Archive-BagIt-0.069.tar.gz` and go to project dir with `cd in Archive-BagIt-0.069`
3. Run `perl Makefile.pl`
4. `(d)gmake`
5. `(d)gmake test`
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)`.
7. with `cpanm Archive::BagIt` test for the version. Result will be something like `Archive::BagIt is up to date (0.069)`.
## Archive::BagIt module
* Sometimes it is offered to update module to a new version
use `cpan Archive::BagIt`. If index not changed to a new one, try `cpanm Archive::BagIt::Fast` or `perl -MCPAN -e 'install Archive::BagIt'`
## Perl module deinstallation
Using cpanm is recommended for an assisted and clean uninstall.
......@@ -35,13 +39,18 @@ Using cpanm is recommended for an assisted and clean uninstall.
* 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)
(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_*`
* For [valid](https://git.slub-dresden.de/slub-digitalpreservation/submissionapplications4rosetta/-/tree/master/examples/bagit/valid_SLUB_bagits) and [faulty](https://git.slub-dresden.de/slub-digitalpreservation/submissionapplications4rosetta/-/tree/master/examples/bagit/faulty_SLUB_bagits) SLUB BagIt examples take a look at submission application project.
* Specification for creating a SLUBArchiv SIP [SLUBArchiv_Produzenten_SIP_Spezifikation.pdf](https://slubarchiv.slub-dresden.de/technische-standards-fuer-die-ablieferung-von-digitalen-dokumenten/)
* SLUBArchiv rights coding specification [SLUBArchiv_Produzenten_Rechteauszeichnung.pdf](https://slubarchiv.slub-dresden.de/technische-standards-fuer-die-ablieferung-von-digitalen-dokumenten/)
## Recommendation
* Do not name your directories `data`
* `mods.xml` and `rights.xml` file names are reserved in directory `mets`. All same file names will be renamed to `1.xml`, `2.xml` and so on
* Use absolute file and directory paths
* If you try to execute the program for the first time, than use `save_option` copy
### Explanation
##### Usage
```perl
......@@ -132,3 +141,7 @@ EXAMPLES
```perl
perl t/slubsipbuilderbagit.t
```
or
```perl
prove t
```
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment