diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..37dcc47e59a604832cf1da5c5b931e1cc0829138 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Audio-Renamer + +## Usage + +``` +usage: audio-renamer.py [-h] [--dry-run] folders [folders ...] + +positional arguments: + folders Folders to run the task on + +optional arguments: + -h, --help show this help message and exit + --dry-run Simulate renames +``` + +## Format + +The hardcoded default format in Amarok syntax is + +``` +%albumartist%/%album%{ (%originalyear%)}/{{%disc%-}%track%. }%title%.%extension% +```