From e271488ea336b5679434385f3a352fd3cd622070 Mon Sep 17 00:00:00 2001 From: Chris Coley <chris@codingallnight.com> Date: Sun, 2 Jun 2019 04:48:40 -0700 Subject: [PATCH] Update the README --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e47b4a8..fb57e9e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ -To use this repository, you need to checkout the repo into a directory in your home directory. Then `cd` into that directory and run the install script. +To use this repository, you need to clone the repo into your home directory. Then `cd` into the cloned repo and run the install script. ```bash -git clone https://gitlab.codingallnight.com/chris/dotfiles.git [directory-name] -cd [directory-name] +cd ~ +git clone https://git.codingallnight.com/chris/dotfiles.git [directory-name] +cd <directory-name> ./install.sh ``` -The install script will take any pre-existing dotfiles that would be overwritten by the installation process and rename them by appending `.old` to the end of the filename. For example, your `.bashrc` file will be renamed to `.bashrc.old`. Then, the script creates symlinks in your home directory that point to files in the repository. +The install script will take any pre-existing dotfiles that would be overwritten by the installation process and rename them by appending `.old` to the end of the filename. For example, your `.bashrc` file will be renamed to `.bashrc.old`. Then, the script creates symlinks in your home directory that point to files in the cloned repository. If you want to customize the `.bashrc` file, you can add a file to your home directory called `.bashrc.local` and the `.bashrc` file will automatically source it. You can see an example of this file in the repo. @@ -16,7 +17,11 @@ To update your dotfiles, all you have to do is pull the latest revision of the r This repository also include several files/directories that are not installed and exist only for my convenience. -- `ssh/` contains the public ssh keys for some of my computers. +- `bin/` contains custom scripts I've created and find useful. +- `ssh/` contains the public ssh keys for some of my systems. - `examples.tar.gz` contains the following 2 directories: - `example-files/` is a directory of many different files types. It is useful when testing out a new syntax highlighting theme. - `test-directory.tar.bz2` is a directory of all the different types of files, directories, and symlinks. It is useful when testing out a new `.dircolors` file. + + +[_modeline]: # ( vi: set ts=4 sw=4 et wrap ft=markdown: ) -- GitLab