README: text enhancements.

master get-tracks-0.2
Karchnu 2021-04-06 16:10:02 +02:00
parent 0e8a90dd81
commit 390659b000
1 changed files with 11 additions and 8 deletions

View File

@ -7,13 +7,16 @@
# Usage
```Bash
get-tracks.sh rip audio-file time-file
get-tracks.sh rip <audio-file> <time-file>
# Example
get-track.sh rip doom-eternal.opus doom-eternal.txt
```
`audio-file` can be in any format understood by `ffmpeg`
`audio-file` can be in any format understood by `ffmpeg`.
In the `time-file`:
The `time-file` must have this format:
```
0:00 First song
@ -23,12 +26,12 @@ In the `time-file`:
# Environment variables
* SIMULATION: if non empty do not invoke ffmpeg
* FORMAT [mp3,ogg,opus,…]: for the song file format
* NONUMBER: if equals 1, do not write song number
* SEPARATOR: (default: ' - '), write song number, with this separator
* **SIMULATION**: if non empty do not invoke ffmpeg
* **FORMAT** [mp3,ogg,opus,…]: for the song file format
* **NONUMBER**: if equals 1, do not write song number
* **SEPARATOR**: (default: ' - '), write song number, with this separator
example with SEPARATOR='_': song names will be 01_song.opus 02_song.opus…
* VERBOSITY [0-3] (default: 1)\
* **VERBOSITY** [0-3] (default: 1)\
verbosity 0: no output exept errors from ffmpeg\
verbosity 1: simple indications on the current track being extracted\
verbosity 2: print actual ffmpeg commands the script currently runs