Skip to content

Commit

Permalink
Update README.md to be more concise
Browse files Browse the repository at this point in the history
  • Loading branch information
franklinovitch committed Dec 29, 2016
1 parent 4e9ef35 commit 8be5f54
Showing 1 changed file with 18 additions and 21 deletions.
39 changes: 18 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,23 @@
Dotfiles
========
This repository includes all of my custom dotfiles. They should be cloned to
your home directory so that the path is `~/dotfiles/`. The included setup
script creates symlinks from your home directory to the files which are located
in `~/dotfiles/`.

The setup script is smart enough to back up your existing dotfiles into a
`~/.dotfiles_old/` directory if you already have any dotfiles of the same name as
the dotfile symlinks being created in your home directory.

I also prefer `zsh` as my shell of choice. As such, the setup script will also
clone the `oh-my-zsh` repository from my GitHub. It then checks to see if `zsh`
is installed. If `zsh` is installed, and it is not already configured as the
default shell, the setup script will execute a `chsh -s $(which zsh)`. This
changes the default shell to zsh, and takes effect as soon as a new zsh is
spawned or on next login.

So, to recap, the install script will:

1. Back up any existing dotfiles in your home directory to `~/.dotfiles_old/`
2. Create symlinks to the dotfiles in `~/dotfiles/` in your home directory
3. Clone the `oh-my-zsh` repository from my GitHub (for use with `zsh`)
All the dots I need.

The included setup script creates symlinks from home directory to the files which
are located in `~/dotfiles/`.

The setup script will back up existing dotfiles into a `~/.dotfiles_old/`
directory if there is already any dotfiles of the same name as the dotfile
symlinks being created in the home directory.

The setup script will also clone the `oh-my-zsh` repository from GitHub and then
checks to see if `zsh` is installed. If `zsh` is installed, and it is not already
configured as the default shell, the setup script will execute a `chsh -s $(which zsh)`.

TL;DR, the install script will:

1. Back up any existing dotfiles in the home directory to `~/.dotfiles_old/`
2. Create symlinks to the dotfiles in `~/dotfiles/` in the home directory
3. Clone the `oh-my-zsh` repository from GitHub (to use with `zsh`)
4. Check to see if `zsh` is installed, if it isn't, try to install it.
5. If zsh is installed, run a `chsh -s` to set it as the default shell.

Expand Down

0 comments on commit 8be5f54

Please sign in to comment.