Merge branch 'main' of git.sr.ht:~rbdr/dotfiles

[rbdr/dotfiles] / README.md

diff --git a/README.md b/README.md
index 95f8cd770c1bfee32ed68e1a9d20fb819e97ef3f..3735424790c74ee9a3011248ed79172f63f44da0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,70 @@
-dotfiles
-========
+# Dotfiles
 
-My Dot Files
\ No newline at end of file
+To set up run `./install`
+
+It provides configuration for:
+
+* nvim
+* tmux
+* zsh
+* git
+* ripgrep
+* tmuxp
+* kitty
+* karabiner
+* weechat
+* nethack
+* terminfo italics support
+* yabai & skhdc
+* asdf
+
+## Prerequisites
+
+The scripts here have support for `brew`, `pacman`, or `apt`.
+Install brew with: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
+
+It might also be a good idea to install the xcode command line tools with `xcode-select --install`
+
+## Provisioning
+
+These dotfiles include some provisioning scripts for `brew`, `pacman`, and `apt`.
+
+To set up run `./provision <recipe>` where `<recipe>` is one of:
+
+* `essential`
+* `nice`
+* `cask_essential` (only `brew`)
+* `cask_nice` (only `brew`)
+
+To see what each recipe installs, check the files under `provisioning/`
+
+## Local zshrc
+
+For local modifications to the zshrc create `~/.zshrc.local`.
+
+## Local vim overrides
+
+For local modifications to your neovim init create `~/.config/nvim/lua/init_local.lua`  
+
+## Environment modification
+
+In order to specify the environment in the prompt, create a function
+called `env_info_provider` and echo your environment details (eg.
+`dev`, `staging`, `production`)
+
+## LSP & Neovim
+
+For the LSP to work, some external dependencies might be needed. As some of 
+these depend on what version asdf has loaded, or specific projects, they're
+not included by default.
+
+See [the nvim-lspconfig docs][lsp] for more info.
+[lsp]: https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md
+
+## Private Files
+
+There are some potentially sensitive files included. They're PGP encrypted. If
+you need them you can run `./sensitive`. To update them if they change,
+run `./sensitive update` instead.
+
+For passwords, make sure you have setup the `pass` store.