fix bash doc formatting; remove some completed chores

This commit is contained in:
JesseBot 2022-12-21 11:54:48 +01:00 committed by GitHub
parent dfa9fafd3d
commit bc1259a1f6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -4,7 +4,7 @@ These started as my personal dot files, but then they became the sensible defaul
[`onboardme`](https://github.com/jessebot/onboardme), which started out as a script
to manage my dot files. Funny how these things work. :shrug:
These directories/files are installed to your home directory.
These directories/files are installed to your home directory and follow the [XDG Base Directory Spec] as closely as possible.
### Sections for each config directory/file
@ -63,34 +63,34 @@ These directories/files are installed to your home directory.
- [`~/.config/bash/minimal.sh`](.config/bash/minimal.sh)
- [`~/.config/bash/text_editing.sh`](.config/bash/text_editing.sh)
## [`~/.config/bash/alias.sh`](.config/bash/alias.sh)
#### [`~/.config/bash/alias.sh`](.config/bash/alias.sh)
a config file to organize all our BASH aliases
## [`~/.config/bash/completion.sh`](.config/bash/completion.sh)
#### [`~/.config/bash/completion.sh`](.config/bash/completion.sh)
enable tab completion
## [`~/.config/bash/history.sh`](.config/bash/history.sh)
#### [`~/.config/bash/history.sh`](.config/bash/history.sh)
- sets history to be in `~/.local/state/bash/history`
- sets default history size
- don't log duplicate history lines
## [`iterm2_shell_integration.sh`](.config/bash/iterm2_shell_integration.sh)
#### [`iterm2_shell_integration.sh`](.config/bash/iterm2_shell_integration.sh)
sets up [iterm2] shell stuff
## [`~/.config/bash/text_editing.sh`](.config/bash/text_editing.sh)
#### [`~/.config/bash/text_editing.sh`](.config/bash/text_editing.sh)
sets either [neovim] or [vim] as your text editor
## [`~/.config/bash/k8s.sh`](.config/bash/k8s.sh)
#### [`~/.config/bash/k8s.sh`](.config/bash/k8s.sh)
kubernetes defaults:
- set pathing for [`krew`][krew], a plugin manager for [`kubectl`][kubectl].
- helpful sensible aliases such as: `kg` for `kubectl get`
## [`~/.config/bash/path.sh`](.config/bash/path.sh)
#### [`~/.config/bash/path.sh`](.config/bash/path.sh)
- set [XDG Base Directory Spec]
- set pathing for golang and python
- set pathing for home brew
## [`~/.config/bash/text_editing.sh`](.config/bash/text_editing.sh)
#### [`~/.config/bash/text_editing.sh`](.config/bash/text_editing.sh)
- fix how less handles non-text input files
- change the default colors for less used in man pages
- changes default pagers used when file is too long for catting
@ -666,8 +666,7 @@ onboardme --git_url https://github.com/your_username/dot_files --git_branch main
### RoadMap
- Get screenshots
- Sort out neovim idiosyncrasies to start using neovim full time (remove plugins that don't work with neovim)
- tidy vim and remove neovim references
- Sort out neovim idiosyncrasies to start using neovim full time
- migrate some of the themeing to a spacechalk org to unify it all
* more in the GitHub Issues