diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 60 |
1 files changed, 26 insertions, 34 deletions
@@ -1,33 +1,34 @@ -# Dotfiles +# Rubén's Configuration Files. -To set up run `./install` +This repository contains my unix configuration files, used on macOS, and +a few linux flavors. -It provides configuration for: - -* nvim -* tmux -* zsh -* git -* ripgrep -* tmuxp -* kitty -* karabiner -* weechat -* nethack -* terminfo italics support -* yabai & skhdc -* asdf +You can check which configurations it provides by checking `config` and `home`. ## 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)"` +The scripts here have support for `brew`, `dnf`, `pacman`, or `apt`. + +It assumes you have an SSH key that can pull from git. + +### macOS +Install brew by following the instructions in [brew.sh](https://brew.sh/). It might also be a good idea to install the xcode command line tools with `xcode-select --install` +## Usage + +1. Clone this repository to `~/.dotfiles` +2. Run `./install` from the root of this project. + +By default, the script will attempt to provision software marked as essential +before installing. You can skip this behavior by using the --skip-provisioning +flag. + ## Provisioning -These dotfiles include some provisioning scripts for `brew`, `pacman`, and `apt`. +These dotfiles include some provisioning scripts for `brew`, `dnf`, `pacman`, +and `apt`. To set up run `./provision <recipe>` where `<recipe>` is one of: @@ -42,9 +43,9 @@ To see what each recipe installs, check the files under `provisioning/` For local modifications to the zshrc create `~/.zshrc.local`. -## Local vim overrides +## Local nvim overrides -For local modifications to your neovim init create `~/.config/nvim/lua/init_local.lua` +For local modifications to your neovim init create `~/.config/nvim/lua/init_local.lua` ## Environment modification @@ -52,19 +53,10 @@ 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, +There are some potentially sensitive files included. They're encrypted with age. +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. +For passwords, make sure you have setup the `passage` store. |