From 1119995914bd8f3eed8ab46d7312f79cbde5a460 Mon Sep 17 00:00:00 2001 From: Salt Date: Mon, 10 Aug 2020 23:37:20 -0500 Subject: [PATCH] Rework README --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index efa0844..41bee7a 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,22 @@ ### Dotfiles -Download and run the latest `build-home.sh`: +Download and run the latest `bootstrap.sh`: cd git clone https://git.9iron.club/salt/bootstrap - ./bootstrap/build-home.sh $HOME + ./bootstrap/bootstrap.sh $HOME -In the event that you want to simply test `build-home.sh`, simply pass a different argument to it: +In the event that you want to simply test `bootstrap.sh`, simply pass a different argument to it: - ./bootstrap/build-home.sh -d /path/to/directory + ./bootstrap/bootstrap.sh -d /path/to/directory -See `build-home.sh -h` for more usage information. +See `bootstrap.sh -h` for more usage information. + +### Older Versions + +`build-home.sh` is an older version of the script kept here for legacy compatibility. Do not use it; use `bootstrap.sh`. ## Notes -* By default, the current working directory will be bootstrapped. Passing `-d` and a different path will cause a different path to be bootstrapped. -* By default, the repository will be cloned over SSH. Either generate some keys and add them to GitLab or change the repository URI to HTTP. -* Ideally, this will be called via Ansible or some other automation tool. It may, in the future, contain specific code for this purpose. +* By default, the user's home directory will be bootstrapped. Passing `-d` and a different path will cause a different path to be bootstrapped. +* By default, the repository will be cloned over SSH. Either generate some keys and add them to your remote server or change the repository URI to HTTP.