dotfiles/README.md
2020-01-10 17:09:14 +01:00

26 lines
909 B
Markdown

# Adrien Luxey's dotfiles
ZSH, Tmux, Vim and Sublime Text dotfiles for Debian-based distros (`install.sh` using `apt`).
## Usage
Use `install.sh` to install the dependencies, Oh-My-Zsh, pull tmux and vim plugins, **remove your previous dotfiles** and symlink the new ones:
$ ./install.sh -h
USAGE: ./install.sh [OPTIONS]
OPTIONS:
-s|--sublime Install Sublime Text 3
-h|--help Show this help
The script will install dependencies once (remove $HOME/.installed to redo) and symlink dotfiles to their destination in your $HOME.
If you do want to install through this script, import you SSH public key to github.com, otherwise the submodules will fail to pull.
If you want to do your own thing from these dotfiles, go read `install.sh`.
## Licence
Public Domain, i.e. do whatever you want with this, but don't come and complain.