sashakoshka/gomp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated Documentation

Browse Source
This commit is contained in:
aditya-K2 2021-12-13 00:15:53 +05:30
parent 75d5d13fbe
commit bc3e5b6741
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/settingup.md
View File

@ -46,7 +46,7 @@ the `music_directory` option ( It is to be noted that goMP assumes that your mpd
`$HOME/.config/mpd/mpd.conf` `$HOME/.config/mpd/mpd.conf`
```yml ```yml
MUSIC_DIRECTORY : "~/Music" # Adding the / at the end is neccessary MUSIC_DIRECTORY : "~/Music"
``` ```
The reason why you need to setup `MUSIC_DIRECTORY` manually because the paths to the songs received from mpd are relative the `MUSIC_DIRECTORY`. The reason why you need to setup `MUSIC_DIRECTORY` manually because the paths to the songs received from mpd are relative the `MUSIC_DIRECTORY`.
@ -119,7 +119,7 @@ Please change the configuration according to your needs.
By Default Images are cached to avoid re-extracting images and making redundant API Calls. The Extracted Images are copied to the `CACHE_DIR` and a reference is added to the `CACHE_FILE` By Default Images are cached to avoid re-extracting images and making redundant API Calls. The Extracted Images are copied to the `CACHE_DIR` and a reference is added to the `CACHE_FILE`
```yml ```yml
CACHE_DIR : "/path/to/the/cache/Directory/" # Adding the / at the end is neccessary CACHE_DIR : "/path/to/the/cache/Directory/"
CACHE_FILE : "/path/to/the/cache/file" # Cache file stores the path to all the images ( think of it like a database. ) CACHE_FILE : "/path/to/the/cache/file" # Cache file stores the path to all the images ( think of it like a database. )
``` ```

2
sample_config.yml
View File

@ -76,7 +76,7 @@ togglePlayBack : [ "p", "SPACE", "]" ] # using the quotes is neccessary.
# 3. Fallback to the default image. # 3. Fallback to the default image.
# #
# #
CACHE_DIR : "/path/to/the/cache/Directory" # for e.g "~/.config/goMP/cache/" Please Note that adding a / at the end is neccessary. CACHE_DIR : "/path/to/the/cache/Directory" # for e.g "~/.config/goMP/cache/"
# You will have to manually create this directory. # You will have to manually create this directory.
CACHE_FILE : "/path/to/the/cache/file" # Cache file stores the path to all the images ( think of it like a database. ) CACHE_FILE : "/path/to/the/cache/file" # Cache file stores the path to all the images ( think of it like a database. )
# Soon will be deprecated. # Soon will be deprecated.