Add README.md

Describes setup and installation of my dotfiles with a (very) brief description.
This commit is contained in:
Gwen Lofman 2017-07-10 19:41:49 -04:00 committed by GitHub
parent 763edb0fd8
commit d101aa9ba8
1 changed files with 19 additions and 0 deletions

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# dotfiles
Yet another dotfiles repository: configuration and scripts for linux machines (basically debian derivatives).
Includes my functions, environment variables, path, custom prompt with git prompt, and more goodies.
# Setup instructions
When running on a new system, to install development files use
```bash
git clone https://github.com/Lionex/dotfiles ~/.dotfiles && cd ~/.dotfiles && . install.sh
```
To simply symlink the dotfiles, use
```bash
git clone https://github.com/Lionex/dotfiles ~/.dotfiles && cd ~/.dotfiles && . setup.sh
```