Update readme with trailing / note

This commit is contained in:
Spider committed 2023-09-18 12:34:49 +00:00
1 parent 67b37321ae
commit c41dfb6fdc
1 file changed
+7 -3
+7 -3
View File
@@ -2,7 +2,6 @@
The AudioInfo Generator is a command-line tool that generates an audioinfo file for a given directory containing FLAC files. This README provides an overview of the tool's functionality, usage, and command-line options.
# Usage
```audioinfo-generator [FLAGS] --directory <DIRECTORY> [--output <OUTPUT>] [--print]```
* `--directory: Sets the directory to scan for FLAC files (required).`
@@ -13,11 +12,16 @@ The AudioInfo Generator is a command-line tool that generates an audioinfo file
* `--verbose or -v: Enables verbose (debug) output. This option can be used to get more detailed information during the execution of the tool.`
# Trailing slashes
Currently clap has a issue with trailing slashes on paths. So if you encounter a issue when trying to generate a file with a path such as
```.\audioinfo.exe -i 'H:\test\test\test_album\'```
Please remove the trailing slash as this causes clap to attach a ``"`` to the end
# Examples
## Generate an audioinfo file for a directory
```.\audioinfo.exe -i 'H:\test\test\test_album'
## Generate an audioinfo file for FLAC files in a specified directory and save it to a custom output file:
```audioinfo --directory /path/to/your/flac_files --output /path/to/output/audioinfo.txt```
## Generate an audioinfo file for FLAC files in a specified directory and print the content to the standard output:
```audioinfo-generator --directory /path/to/your/flac_files --print```
## Enable verbose (debug) output:
```audioinfo --directory /path/to/your/flac_files --verbose```
```audioinfo --directory /path/to/your/flac_files --verbose```