From 3a805f9bf23038900101e813f7c5ad643fc60628 Mon Sep 17 00:00:00 2001 From: Alan Orth Date: Sun, 2 Aug 2020 22:55:23 +0300 Subject: [PATCH] README.md: Add more documentation and notes --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 684d144..2e2f4f7 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,32 @@ # DSpace Curation Tasks Metadata curation tasks used on the [CGSpace](https://cgspace.cgiar.org) institutional repository: -- CountryCodeTagger: tag items with appropriate country codes based on their existing country metadata +- *CountryCodeTagger*: add ISO 3166-1 Alpha2 country codes to items based on their existing country metadata Tested on DSpace 5.8. Read more about the [DSpace curation system](https://wiki.lyrasis.org/display/DSDOC5x/Curation+System). +## Build and Install +To build the standalone jar: + +``` +$ mvn package +``` + +Copy the resulting jar to the DSpace `lib` directory: + +``` +$ cp target/dspace-curation-tasks-1.0-SNAPSHOT.jar ~/dspace/lib/dspace-curation-tasks-1.0-SNAPSHOT.jar +``` + +## Invocation +Once the jar is installed and you have added appropriate configuration in `~/dspace/config/modules`: + +``` +$ ~/dspace/bin/dspace curate -t countrycodetagger -i 10568/3 -r - -l 500 -s object +``` + +_Note_: it is very important to set the cache limit (`-l`) and the database transaction scope to something sensible (`object`) if you're curating a community or collection with more than a few hundred items. + ## Notes This project was initially created according to the [Maven Getting Started Guide](https://maven.apache.org/guides/getting-started/):