Update readme with new install instructions

This commit is contained in:
David Todd (c0de) 2018-05-16 21:14:17 -05:00
parent e464fdce93
commit 974e1e8ed1
2 changed files with 31 additions and 10 deletions

10
README
View File

@ -1,10 +0,0 @@
Dotfiles!
This is the primary branch.
It includes changes that should be included in most, if not
all of the different configurations that may result of different
system use.
For now, there is the master and macos
The macos branch is mostly athestic changes and plugins chosen
for my macbook.

31
README.md Normal file
View File

@ -0,0 +1,31 @@
# Dotfiles!
## Installation
1. Optionally create ~/.dotfiles.postinst
2. `curl -sL https://raw.githubusercontent.com/alopexc0de/dotfiles/master/install.sh | bash`
3. ????
4. Profit
## Dotfiles Postinstall
You may create a standard text file called `.dotfiles.postinst` in your home directory before installing.
This file contains commands, one per line, that will be executed in order after the install script finishes.
For example, you may want to add commands such as `git config --global user.name "My Name"` and `git config --global user.email "me@my.email"`
## Customizing Dotfiles
1. Fork this repo
2. Update `repourl` inside install.sh to point to your own
3. Make your changes
4. Push to origin
5. Install your new dotfiles everywhere
## Branch Info
This is the primary branch.
It includes changes that should be included in most, if not
all of the different configurations that may result of different
system use.
For now, there is the master and macos
The macos branch is mostly athestic changes and plugins chosen
for my macbook.