salt
/
dotfiles
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add a script for updating submodules, make README nicer

This commit is contained in:
Salt 2021-01-19 02:16:17 -06:00
parent deb6ad1c87
commit 967ffe1310
2 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -20,4 +20,22 @@ However, I would *also* highly recommend using this stow-based approach instead
## Overview
TODO: Overview of config sets
This stash contains a number of packages for numerous situations:
| package | description |
| --- | --- |
| `base` | The base package contains shell and core utility configuration. Other packages do not depend on it; it merely contains basic configuration that I find necessary in every case. |
| `bin` | My custom binaries, plonked at `~/.bin`. |
| `desktop-common` | Common configuration shared across all possible rices. This contains things such as keybindings for applications, Quake configs, Redshift, etc. Configuration files with themes are avoided where possible. |
| `desktop-gruvbox` | My current rice and its accompanying configs. A nice and simple one with Rofi, bspwm, Dunst, Compton, and Polybar. |
| `firestarter` | A custom set of desktop environment scripts that I threw together to manage my environment without worrying about the fine details all the time. See the Firestarter repo for more info. |
| `git` | My personal git configuration. Separated from base because sometimes I don't want cockmail on all my commits. |
| `mac` | MacOS-specific configs. Very sparse; I hardly ever have to use one. |
| `ssh` | SSH configuration for my desktop machines. |
| `vim` | Configuration for Vim, everybody\*'s favorite text editor. Contains a fair few plugins and a mildly flabby `.vimrc`. |
Included within are also a handful of management scripts.
| script | description |
| --- | --- |
| `submodule-checkout-masters-and-update.sh` | For every submodule in the repo, checks out its master branch (instead of the exact commit specified in the base repo) and then pulls from upstream. Effectively, this updates any submodules in the repo, such as Vim plugins, themes, etc. |

4
submodule-checkout-masters-and-update.sh Executable file
View File

@ -0,0 +1,4 @@
#! /bin/sh
git submodule update --recursive --remote --init
git submodule -q foreach 'git checkout -q master && git pull'
git status