From bc3e5b6741887c466b236d299944230a65ac4b64 Mon Sep 17 00:00:00 2001 From: aditya-K2 Date: Mon, 13 Dec 2021 00:15:53 +0530 Subject: [PATCH] Updated Documentation --- docs/settingup.md | 4 ++-- sample_config.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/settingup.md b/docs/settingup.md index 486825c..ad7034f 100644 --- a/docs/settingup.md +++ b/docs/settingup.md @@ -46,7 +46,7 @@ the `music_directory` option ( It is to be noted that goMP assumes that your mpd `$HOME/.config/mpd/mpd.conf` ```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`. @@ -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` ```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. ) ``` diff --git a/sample_config.yml b/sample_config.yml index a2d0677..98858ab 100644 --- a/sample_config.yml +++ b/sample_config.yml @@ -76,7 +76,7 @@ togglePlayBack : [ "p", "SPACE", "]" ] # using the quotes is neccessary. # 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. 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.