Skip to content

Commit cfd1acf

Browse files
author
atla5
committed
config: add '-h' output to README, rm unused 'config/internal'
1 parent 2223ed8 commit cfd1acf

File tree

3 files changed

+29
-66
lines changed

3 files changed

+29
-66
lines changed

README.md

+29-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ Assist in cataloguing batches of similar or series-based items from a collection
1010
* minimizing repetitive typing and template editing
1111
* combining the information that is shared across items in a collection in one place
1212

13-
### Usage Instructions
13+
## Usage
14+
15+
### Process Instructions
1416

1517
1. _Edit Config File_:
1618
If desired, edit the configuration file to customize the format of the header
@@ -40,6 +42,32 @@ After completion of the above tasks, the text files can be discarded as
4042
|~~M~~|~~.mrk~~|MARC format which will likely need to be compiled into .mrc|
4143
|...|...| Feel free to fork and create more output types or suggest different uses.|
4244

45+
### Raw Help Output
46+
47+
Use `-h` at any time to get (something like) the following:
48+
49+
```
50+
usage: dublin-core-text-parser
51+
52+
A cataloguing tool for converting specially formatted text files
53+
containing dublin core metadata into various formats
54+
55+
-c,--config <arg> Reference to a file containing alternative header
56+
arrangements
57+
-C,--csv Create a single .csv file containing metadata of
58+
each item
59+
-h,--help Display the help information
60+
-J,--json Create a single .json file containing metadata of
61+
each item
62+
-M,--mrk Create a single .mrk file containing metadata of
63+
each item
64+
-o,--output <arg> Name the output file
65+
-s,--shared <arg> file location of the shared.csv file containing the
66+
shared fields
67+
-X,--xml Create a single .xml file containing metadata of
68+
each item
69+
```
70+
4371
### External Links
4472

4573
* [Wiki for this program!](https://github.com/atla5/dublin-core-text-parser/wiki)

main/config/internal/options.txt

-56
This file was deleted.

main/config/internal/tinylog.properties

-9
This file was deleted.

0 commit comments

Comments
 (0)