mirrors/irs
1
1
Fork 0
mirror of https://github.com/cooperhammond/irs.git synced 2024-12-21 17:25:28 +00:00
Code Issues Projects Releases Wiki Activity

updated documentation #85

Browse source
This commit is contained in:
cooperhammond 2022-02-23 10:59:15 -07:00
parent 3bbb0e767a
commit c99e8257e9
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -124,6 +124,7 @@ Here's what they do:
```yaml ```yaml
binary_directory: ~/.irs/bin binary_directory: ~/.irs/bin
music_directory: ~/Music music_directory: ~/Music
search_terms: "lyrics"
filename_pattern: "{track_number} - {title}" filename_pattern: "{track_number} - {title}"
directory_pattern: "{artist}/{album}" directory_pattern: "{artist}/{album}"
client_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX client_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
@ -136,6 +137,8 @@ single_folder_playlist:
- `binary_directory`: a path specifying where the downloaded binaries should - `binary_directory`: a path specifying where the downloaded binaries should
be placed be placed
- `music_directory`: a path specifying where downloaded mp3s should be placed. - `music_directory`: a path specifying where downloaded mp3s should be placed.
- `search_terms`: additional search terms to plug into youtube, which can be
potentially useful for not grabbing erroneous audio.
- `filename_pattern`: a pattern for the output filename of the mp3 - `filename_pattern`: a pattern for the output filename of the mp3
- `directory_pattern`: a pattern for the folder structure your mp3s are saved in - `directory_pattern`: a pattern for the folder structure your mp3s are saved in
- `client_key`: a client key from your spotify API application - `client_key`: a client key from your spotify API application