From 4f4e67ff1c0e84f1462a14072157245ae84f9688 Mon Sep 17 00:00:00 2001
From: Marty Oehme <marty.oehme@gmail.com>
Date: Wed, 8 Jul 2020 13:51:27 +0200
Subject: [PATCH] [repo] Add & update docs, fix install script dirs

---
 bootstrap/README.md |  7 +++++++
 install.sh          | 11 ++++++-----
 mpv/README.md       |  3 ++-
 3 files changed, 15 insertions(+), 6 deletions(-)
 create mode 100644 bootstrap/README.md

diff --git a/bootstrap/README.md b/bootstrap/README.md
new file mode 100644
index 0000000..35953d7
--- /dev/null
+++ b/bootstrap/README.md
@@ -0,0 +1,7 @@
+# bootstrap module
+
+The bootstrapping module mainly concerns the setup of the repository itself -- installation of packages, setting up basic options and maintenance scripts.
+
+* installs general list of packages, listed [here](bootstrap/packages.txt)
+* if githooks are enabled (either through install script, or manually) will compare installed packages with those on the package list on each commit and warn user about differences (skipping those on the [ignore](bootstrap/packages_ignore.txt) list).
+* contains a simple alias `dotlink` which allows quickly re-linking dotfiles when they have been changed. This is useful to invoke when files have been removed or added and need to be sym-linked by stow again (only works for `~/.dotfiles` dot directory).
diff --git a/install.sh b/install.sh
index 7ce8596..095cc63 100755
--- a/install.sh
+++ b/install.sh
@@ -2,13 +2,14 @@
 #
 # install.sh
 #
-# Installs dotfiles and packages for my setup
+# Installs dotfiles and packages for my setup.
+# Needs to be invoked from containing dotfile directory to work correctly.
 #
-# Will first install yay, then all my used packages (read from bootstrap/packages.csv)
+# Will first install yay, then all my used packages (read from bootstrap/packages.txt)
 #
 # Finally, symlinks all dotfiles into their correct locations using stow
 
-bootstrap_dir="${BOOTSTRAP_DIRECTORY:-./_bootstrap}"
+bootstrap_dir="${BOOTSTRAP_DIRECTORY:-./bootstrap}"
 
 main() {
   local cmd=""
@@ -64,10 +65,10 @@ install() {
   fi
   echo "====================== BEGINNING INSTALLATION ============================="
   if ! "$unattended"; then
-    export BOOTSTRAP_PACKAGES="_bootstrap/packages.txt"
+    export BOOTSTRAP_PACKAGES="bootstrap/packages.txt"
     "$bootstrap_dir"/install_packages.sh
   else
-    export BOOTSTRAP_PACKAGES="_bootstrap/packages.txt"
+    export BOOTSTRAP_PACKAGES="bootstrap/packages.txt"
     "$bootstrap_dir"/install_packages.sh -f
   fi
   unset BOOTSTRAP_PACKAGES
diff --git a/mpv/README.md b/mpv/README.md
index d6119ef..cfe7774 100644
--- a/mpv/README.md
+++ b/mpv/README.md
@@ -3,6 +3,7 @@
 [mpv](https://mpv.io) -- free, open-source, cross-platform media player
 
 mpv is set up to hopefully strike a balance between high quality playback, streaming with a reasonable speed and saving battery power.
+It is set up to play both local files and streams from the web (especially youtube with playlisting and ad skipping), via a qutebrowser mapping if the corresponding module is installed.
 
 * mpv by default does not come with a gui, this configuration uses [uosc](https://github.com/darsain/uosc) to enable a comfortable gui
 * available subtitles are loaded and shown in a consistently high quality, as much as possible
@@ -13,7 +14,7 @@ mpv is set up to hopefully strike a balance between high quality playback, strea
 * default video is adjusted for playback during the day, in a normally lit room
 * simple context menu (opened with `menu` key on keyboard) to load files, subtitles, chapters, and more
 * newly defined keybindings, look in `input.conf` for their definitions
-* when a battery
+* when a battery is being discharged, mpv starts in a slightly lower quality but battery saving playback profile
 
 ## vim-like navigation