Marty/dotfiles
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases Wiki Activity

[repo] Add & update docs, fix install script dirs

Browse source
This commit is contained in:
Marty Oehme 2020-07-08 13:51:27 +02:00
parent 14d56b5544
commit 4f4e67ff1c
No known key found for this signature in database
GPG key ID: 0CCB0526EFB9611A
3 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
bootstrap/README.md Normal file
View file

@ -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).

11
install.sh
View file

@ -2,13 +2,14 @@
# #
# install.sh # 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 # Finally, symlinks all dotfiles into their correct locations using stow
bootstrap_dir="${BOOTSTRAP_DIRECTORY:-./_bootstrap}" bootstrap_dir="${BOOTSTRAP_DIRECTORY:-./bootstrap}"
main() { main() {
local cmd="" local cmd=""
@ -64,10 +65,10 @@ install() {
fi fi
echo "====================== BEGINNING INSTALLATION =============================" echo "====================== BEGINNING INSTALLATION ============================="
if ! "$unattended"; then if ! "$unattended"; then
export BOOTSTRAP_PACKAGES="_bootstrap/packages.txt" export BOOTSTRAP_PACKAGES="bootstrap/packages.txt"
"$bootstrap_dir"/install_packages.sh "$bootstrap_dir"/install_packages.sh
else else
export BOOTSTRAP_PACKAGES="_bootstrap/packages.txt" export BOOTSTRAP_PACKAGES="bootstrap/packages.txt"
"$bootstrap_dir"/install_packages.sh -f "$bootstrap_dir"/install_packages.sh -f
fi fi
unset BOOTSTRAP_PACKAGES unset BOOTSTRAP_PACKAGES

3
mpv/README.md
View file

@ -3,6 +3,7 @@
[mpv](https://mpv.io) -- free, open-source, cross-platform media player [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. 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 * 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 * 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 * 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 * 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 * 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 ## vim-like navigation