aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorMitchell Riedstra <mitch@riedstra.dev>2021-10-29 21:53:53 -0400
committerMitchell Riedstra <mitch@riedstra.dev>2021-10-29 21:53:53 -0400
commit5b25c5155312f626813e0d36b7933f5eba801dd2 (patch)
tree6e264a92dbe13ed77821a5c5bd536b6701768442 /readme.md
parente9b933ea6ce85f5d4f4653b7e5e6a7c836fcc893 (diff)
downloaddotfiles-5b25c5155312f626813e0d36b7933f5eba801dd2.tar.gz
dotfiles-5b25c5155312f626813e0d36b7933f5eba801dd2.tar.xz
Major dotfile cleanup
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md39
1 files changed, 21 insertions, 18 deletions
diff --git a/readme.md b/readme.md
index d3d29bc..832f1e0 100644
--- a/readme.md
+++ b/readme.md
@@ -8,7 +8,7 @@ Things of interest:
* tmux configuration ( see more info below )
* tmux helper script ( For load average, uptime and memory in the status bar )
* basic configuration ( For if you don't want the custom status bar )
- * [`keyCheck.sh`](keyCheck.sh) Automatically generate a 4096bit RSA SSH key or display the one you have
+ * [`scripts/key-check.sh`](
* Snapshot scripts. Snapshots your entire OS see below for more details.
* A basic vim configuration ( also see [`vim-cfg`](https://git.riedstra.dev/mitch/vim-cfg/about) )
* A handful of build scripts with my options for some open source projects such as Vim
@@ -17,22 +17,34 @@ Things of interest:
These alter the fstab in the snapshot so you can boot to it just by changing kernel boot parameters
-### [`snap/btrfs.sh`](`snap/btrfs.sh`)
+### [`scripts/snap-btrfs.sh`](`scripts/snap-btrfs.sh`)
Automatically snapshot a btrfs root filesystem assuming you're using a
subvolume and the base FS is mounted in `/ROOT`
-[`snap/lvm.sh`](`snap/lvm.sh`)
+[`scripts/snap-lvm.sh`](`scripts/snap-lvm.sh`)
Same as above, except it doesn't keep RO snapshots around, and doesn't remove
old ones. Requires LVM but the underlying FS doesn't matter ( `ext4`, `xfs`,
etc )
+## `bin` directory / desktop utilities
+
+ * `snipmenu`, a small [dmenu](https://dmenu.suckless.org) script for pasting
+ snippets from the `snips` directory.
+ * `status-bar` a *very* messy script for a `dwm` status
+ * `vol` small script to adjust pulseaudio volume on linux
+ * `day`/`night` scripts for turning off/on `redshift`
+ * `wallpaper` small script to continuously adjust the wallpaper, useful
+ for when your screen resolution changes
+ * `backlight` directly adjust the backlight on Linux systems
+ * `ddmenu` dmenu for demenus. Dmenu script that launches other dmenu scripts.
+
## Shell Configuration
-`kshrc`, generated using `build.sh` inside of the `shell/` directory.
+`kshrc`
Specifically targets ksh which has been my default shell for quite a long time
-now. Though I do test it against `bash` and `ash` as well.
+now. Though I do test it against `bash` and `ash` occasionally as well.
Some useful features are:
@@ -74,17 +86,8 @@ Some useful features are:
* `updatevimrc_basic` Installs the `.vimrc` file which is a basic but useful vim configuration.
* `updatetmuxconf` Pulls in the tmux configuration from this repository.
* `updateshell` Pulls the latest version of `kshrc` from this repository.
- * `pullkeys_github <github_username>` Creates the `~/.ssh/authorized_keys` file with the SSH keys for a given github username
- * Conf<br /><br />
- All of the pieces above don't actually do anything automatically, they just
- add shell functions that can be called. This file ties it all together.
- <br />
- It:
- * sets the URLs for the update functions,
- * the configuration file location
- * sources the pre and post configuration files
- * sets the color aliases and environment variables if necessary
- * adjusts PATH to include `~/bin`
- * It also handles the different supported shells, history, etc
- * Sets up a basic PS1 for most shells
+ * `pullkeys_github <github_username>` Creates the `~/.ssh/authorized_keys`
+ file with the SSH keys for a given github username
+ * `updategitconf <name>` Creates `~/.gitconfig` with the file from
+ `gitconfig/<name>`