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

Fixed README.md file

parent 1532d926
No related branches found
No related tags found
No related merge requests found
...@@ -9,7 +9,6 @@ NOTE: The use of option `copy` is strongly recommended. The remaining options mo ...@@ -9,7 +9,6 @@ NOTE: The use of option `copy` is strongly recommended. The remaining options mo
## Supported Operating Systems ## Supported Operating Systems
* Debian 10 * Debian 10
* Windows 10 * 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 ## Requirements
* Perl version 5.28 or higher * Perl version 5.28 or higher
...@@ -31,7 +30,7 @@ RECOMMENDED: strawberry perl environment [strawberry-perl-5.30.3.1-64bit-portabl ...@@ -31,7 +30,7 @@ RECOMMENDED: strawberry perl environment [strawberry-perl-5.30.3.1-64bit-portabl
## Archive::BagIt module ## Archive::BagIt module
* Sometimes it is offered to update module to a new version * 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'` use `cpan Archive::BagIt`. If version not changed to a new one, try `cpanm Archive::BagIt` or `perl -MCPAN -e 'install Archive::BagIt'`
## Perl module deinstallation ## Perl module deinstallation
Using cpanm is recommended for an assisted and clean uninstall. Using cpanm is recommended for an assisted and clean uninstall.
...@@ -53,7 +52,7 @@ Using cpanm is recommended for an assisted and clean uninstall. ...@@ -53,7 +52,7 @@ Using cpanm is recommended for an assisted and clean uninstall.
7. Extract files from archive 7. Extract files from archive
8. Change console path to extracted SLUB_SIP_Builder 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) ...' 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. 10. Copy from error module name and install it, repeat step 9 and 10 till test process starts.
* `cpanm MARC::Record` * `cpanm MARC::Record`
* `cpanm XML::XPath` * `cpanm XML::XPath`
* `cpanm DateTime::Format::ISO8601` * `cpanm DateTime::Format::ISO8601`
...@@ -70,7 +69,7 @@ Using cpanm is recommended for an assisted and clean uninstall. ...@@ -70,7 +69,7 @@ Using cpanm is recommended for an assisted and clean uninstall.
## Recommendation ## Recommendation
* Do not name your directories `data` * 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 * `marc21.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 * Use absolute file and directory paths
* If you try to execute the program for the first time, than use `save_option` copy * If you try to execute the program for the first time, than use `save_option` copy
...@@ -89,7 +88,7 @@ Usage: ...@@ -89,7 +88,7 @@ Usage:
-save_option=<option> payload files save as <copy>, <move>, <replace>, the <copy> option should be prefered -save_option=<option> payload files save as <copy>, <move>, <replace>, the <copy> option should be prefered
-IE_directory=<IE dir> existing IE directory (absolute path!) -IE_directory=<IE dir> existing IE directory (absolute path!)
-SIP_output_path=<target dir> where to put the SIP dir (absolute path!) -SIP_output_path=<target dir> where to put the SIP dir (absolute path!)
-ppn=<ppn>|-noppn=<noppn> SWB-PPN or any identifier (uses minimalistic MODS) -ppn=<ppn>|-noppn=<noppn> SWB-PPN or any identifier (uses minimalistic marc21)
-SIP_version=<version> mandatory, needs for identification of SIP format, supported <v2020.1> -SIP_version=<version> mandatory, needs for identification of SIP format, supported <v2020.1>
-external_workflow=<workflow> mandatory, should be uniqe workflow name -external_workflow=<workflow> mandatory, should be uniqe workflow name
...@@ -131,7 +130,7 @@ EXAMPLES ...@@ -131,7 +130,7 @@ EXAMPLES
--external_id=10008 --external_workflow=kitodo --external_ISIL=DE-14 --external_id=10008 --external_workflow=kitodo --external_ISIL=DE-14
--external_value_descr="Gesetzlicher Auftrag" --rights_version=1.0 --external_value_descr="Gesetzlicher Auftrag" --rights_version=1.0
--rights_xml=/metadata/rights/Fallbeispiel-01.xml --rights_xml=/metadata/rights/Fallbeispiel-01.xml
--add_meta_file=/metadata/lido.xml --add_meta_file=/metadata/mods.xml --add_meta_file=/metadata/lido.xml --add_meta_file=/metadata/marc21.xml
--add_key_value="Author:Lew Nikolajewitsch Tolstoi" --add_key_value="Author:Lew Nikolajewitsch Tolstoi"
--add_key_value="Titel:Krieg und Frieden" --add_key_value="Genre:Roman" --add_key_value="Titel:Krieg und Frieden" --add_key_value="Genre:Roman"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment