From 10d0946a7382397014ebbf75fe0ae4d145083d4d Mon Sep 17 00:00:00 2001 From: mappu Date: Sun, 22 Oct 2017 00:00:00 +1300 Subject: [PATCH] doc: update README --- dist/README.txt | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 dist/README.txt diff --git a/dist/README.txt b/dist/README.txt new file mode 100644 index 0000000..727db6d --- /dev/null +++ b/dist/README.txt @@ -0,0 +1,43 @@ +Script to rename filenames in a certain way. + +`shunt_tags` shunt tags to the end of filenames, transforming `[RELEASEGROUP] Title - Episode [CRC32].mkv` into `Title - Episode [RELEASEGROUP CRC32].mkv`, in order to improve alphabetical sort ordering. The original goal has expanded into a large number of transforms with a comprehensive test suite. + +Written in PHP, bash, batch + +Tags: anime + +=USAGE (v3)= + +`Usage: + shunt_tags [OPTIONS] + +Options: + -y --accept Apply updates without prompting. (false) + -d --directory DIR Set directory. (pwd) + --display table|dump|none Choose display mode. ('table') + -n --dry-run Display proposed updates and exit. (false) + --help, --usage Display this message + --interactive Prompt whether to apply updates. (true) + -q --quiet Quiet mode hides scanning progress. (false) + -qq --quiet2 Equivalent to "-q --display none" + -r --recursive Apply to subdirectories. (false) + --test-suite Run test suite and exit + --undo Display an undo script +` + +=CHANGELOG= + +2017-10-22 v3.0 +- Rewritten in PHP +- Feature: Many more features now available via command-line arguments + +2017-04-05 v2.0 +- Rewritten in bash, now requires linux ports of `rren` and `pause` +- Feature: Support `--graphical` argument to relaunch itself under `xfce4-terminal` + +201?-??-?? v1.5 +- Support additional filename transforms + +2015-01-17 v1.0 +- Initial public release +- Written in batch, requires `rren` in path