Update readme

This commit is contained in:
Pratik Tripathy
2021-07-06 02:42:03 +05:30
parent 20da8ce2f9
commit 2a4d72f10f

View File

@@ -1,3 +1,21 @@
# dotfiles
Place to keep my .dotfiles so I do not have to worry about migrating to another system.
Place to keep my .dotfiles so I do not have to worry about migrating to another system.
## Usage
```bash
$ bash bootstrap.sh -h
Applies all settings stored in the script's directory to your home directory
Usage: bootstrap.sh [-q|--quiet] [-l|--create-links]
-q, --quiet No screen outputs
-l, --create-links Creates soft-links to files in the current directory instead of copying them
Example: bash ./bootstrap.sh -q --create-links
```
## Why `--create-links`?
I have multiple Linux installations on my machine. Linking it from one place (this repository) keeps things tidy. Also, changes to dotfiles automatically get applied to all the distros.