mirror of
https://github.com/mitchell/dotfiles.git
synced 2026-08-10 08:09:35 +00:00
chore(README): update description and lists
This commit is contained in:
parent
46b25218f8
commit
8dc22335bc
1 changed files with 11 additions and 28 deletions
39
README.md
39
README.md
|
|
@ -1,49 +1,32 @@
|
||||||
# mitchell's dotfiles
|
# mitchell's dotfiles
|
||||||
|
|
||||||
This mostly exists for my convenient bootstrapping onto new systems. I would generally recommend
|
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,
|
drawing from individual applications' configurations as inspiration for your own dotfiles. But I use
|
||||||
the included scripts should be generalized enough to work on anybody's machines.
|
Stow to link each config module into my home dir, and things should be general enough to use
|
||||||
|
yourself.
|
||||||
|
|
||||||
This repo contains my preferred configurations for:
|
This repo contains my preferred configurations for:
|
||||||
|
|
||||||
- neovim
|
- neovim
|
||||||
- fish shell
|
- fish shell
|
||||||
|
- zsh shell
|
||||||
- git
|
- git
|
||||||
- tmux
|
- tmux
|
||||||
- wezterm (X11/macOS)
|
- ghostty
|
||||||
- ghostty (X11/Wayland)
|
- wezterm
|
||||||
- keepassxc
|
- bspwm/sxhkd (x11)
|
||||||
- bspwm (X11)
|
- sway (wayland)
|
||||||
- sxhkd (X11)
|
- niri (wayland)
|
||||||
- Niri (Wayland)
|
- yabai/skhd (macos)
|
||||||
- yabaiwm (macOS)
|
|
||||||
- skhd (macOS)
|
|
||||||
|
|
||||||
## Scripts
|
## Scripts
|
||||||
|
|
||||||
### `sync`
|
|
||||||
|
|
||||||
**Dependencies**
|
|
||||||
|
|
||||||
- fish
|
|
||||||
- git
|
|
||||||
- rsync
|
|
||||||
- curl
|
|
||||||
|
|
||||||
**Description**
|
|
||||||
|
|
||||||
> **Warning:** This will overwrite any existing files by the same name.
|
|
||||||
|
|
||||||
Syncs all configuration files found in this repository to your home folder.
|
|
||||||
|
|
||||||
To run sync script using curl: `curl https://raw.githubusercontent.com/mitchell/dotfiles/master/sync | fish`
|
|
||||||
|
|
||||||
### `install_utils`
|
### `install_utils`
|
||||||
|
|
||||||
**Dependencies**
|
**Dependencies**
|
||||||
|
|
||||||
- git
|
- git
|
||||||
- fish
|
- bash
|
||||||
|
|
||||||
**Description**
|
**Description**
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue