Add readme and sync script

This commit is contained in:
mitchell 2019-08-15 01:50:59 -04:00
parent e57d8318d9
commit 874cf19e3e
2 changed files with 35 additions and 0 deletions

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# 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 repo contains my preferred configurations for:
- fish shell
- vim
- tmux
- git
Which also implies they are all dependencies to use the whole configuration.
Other dependencies:
- rsync (for sync script)
- curl (for fisher pkg manager)
To use all of the configurations:
1. Clone this repo with the `--recurse-submodules` flag.
1. `cd` into this repo and run the `sync` script (requires fish).
1. If you haven't already either run `fish` or change your default shell by adding the result of
`which fish` to `/etc/shells` and running `chsh -s /path/to/fish yourusername` and restart the
terminal.
1. Once using fish run `fisher` to install all fish plugins.
1. Enjoy!

10
sync Normal file
View File

@ -0,0 +1,10 @@
#!/usr/bin/env fish
echo 'Syncing configuration files to your home dir...'
rsync -aP ./.config/fish ~/.config/
rsync -aP ./.gitconfig ~/
rsync -aP ./.tmux* ~/
rsync -aP ./.vim* ~/
echo 'Done syncing.'