diff --git a/README.md b/README.md index 0296853..f536a6a 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,59 @@ # mitchell's dotfiles -This mostly exists for my convenient bootstrapping onto new systems, but it should be generalized -enough for anyone to use it. +This mostly exists for my convenient bootstrapping onto new systems. I would generally recommend +drawing from individual applications' configurations as inspiration for your own dotfiles. However, +the included scripts should be generalized enough to work on anybody's machines. This repo contains my preferred configurations for: + - fish shell -- vim +- neovim - tmux - git -- yabai wm -- skhd -- kitty term +- kitty terminal +- Jetbrains vim plugin +- keepassxc +- qutebrowser +- bspwm (Linux) +- sxhkd (Linux) +- yabaiwm (macOS) +- skhd (macOS) -Which also implies they are all dependencies to use the whole configuration. +## Scripts + +### `sync` + +**Dependencies** -Installation dependencies: -- git - fish -- rsync (for sync script) +- git +- neovim +- rsync - curl -To install from fish shell: `curl https://raw.githubusercontent.com/mitchell/dotfiles/master/sync | .` +**Description** -To install all of the configuration from bash and then change default shell: -1. Clone this repo with the `--recurse-submodules` flag. -1. `cd` into your clone and run the `sync` script (requires fish be installed). -1. If you haven't already either run `fish` or change your default shell by appending the result of - `which fish` to `/etc/shells` and running `chsh -s /path/to/fish yourusername`, then restarting - the terminal. -1. Enjoy! +Syncs all configuration files found in this repository to your home folder. -Dependencies for fish aliases: -- fzf (used in `v`) -- ag (used in `vs`) +To run sync script using curl: `curl https://raw.githubusercontent.com/mitchell/dotfiles/master/sync | fish` -Dependencies for prompt info (only needed in relevant projects): -- golang -- docker -- node -- typescript -- elixir -- dart -- flutter +### `upgrade_debian` + +**Dependencies** + +- fish + +**Description** + +Upgrade from Debian stable to unstable. + +### `provision_debian` + +Dependencies + +- fish + +**Description** + +Provision various environments and tools on Debian. Run `./run help` and peek inside for more +information.