Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hmiguim committed Oct 20, 2023
1 parent 3da71b6 commit 745b8db
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ valid EARK2 SIP.
To validate a SIP have to use the following options:

* **validate**, [REQUIRED] this option is for the CLI to know that is to perform the validation of a SIP.
* **-i,** [REQUIRED] Path(s) to the SIP(s) archive file or folder(s).
* **-cv,** [OPTIONAL] Commons IP version (Default: 2.1.0).
* **-o,** [OPTIONAL] Path to the Directory where you want to save the validation report.
* **-r,** [OPTIONAL] The type of report (Valid Option eark or default)
* **-v,** [OPTIONAL] Verbose option (Will print all validation steps)
* **-i,** or **--inputs** [REQUIRED] Path(s) to the SIP(s) archive file or folder(s).
* **--specification-version,** [OPTIONAL] E-ARK CSIP version (Default: 2.1.0).
* **-o,** or **--output-report-dir** [OPTIONAL] Path to the Directory where you want to save the validation report.
* **-r,** or **--reporter-type** [OPTIONAL] The type of report (possible values: commons-ip, pyip)
* **-v,** or **--verbose** [OPTIONAL] Verbose option (Will print all validation steps)
* **-h,** [OPTIONAL] Display this help and exit.

To create a EARK-2 SIP have to use the following options:
Expand All @@ -62,14 +62,14 @@ To create a EARK-2 SIP have to use the following options:
* **-T** or **--target-only**, [OPTIONAL] Adds only the files for the representations.
* **-v** or **--version**, [OPTIONAL] E-ARK SIP specification version (Default: 2.1.0)
* **--submitter-name**, [OPTIONAL] The name of the submitter agent.
* **--submiter-id**, [OPTIONAL] The identification code (ID) of the submitter agent.
* **--submitter-id**, [OPTIONAL] The identification code (ID) of the submitter agent.
* **--sip-id**, [OPTIONAL] ID of the SIP.
* * **--override-schema**, [OPTIONAL] Overrides default schema.

This is the descriptive metadata section:
* **--metadata-file** [REQUIRED] Path to descriptive metadata file.
* **--metadata-type**, [REQUIRED] Descriptive metadata type.
* **--metadata-schema**, [OPTIONAL] Path to descriptive metadata schema file.
* **--override-schema**, [OPTIONAL] Overrides default schema
* **--metadata-version**, [OPTIONAL] Descriptive metadata version.

**NOTE:** if does not give the metadata version, the tool try to obtain this values from the file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public class Validate implements Callable<Integer> {
"--verbose"}, description = "Verbose command line output with all validation steps")
boolean verbose;

@CommandLine.Option(names = {"-cv", "--commons-version"}, description = "Commons IP version")
@CommandLine.Option(names = {"--specification-version"}, description = "E-ARK CSIP version")
String version = "2.1.0";

@Override
Expand Down

0 comments on commit 745b8db

Please sign in to comment.