salt/bootstrap
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix up our README a bit

Browse Source
This commit is contained in:
Salt 2020-11-10 09:57:29 -06:00
parent 55fc814a40
commit 50db78f9d3
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,8 +1,8 @@
# Salt's Bootstrap Script # Salt's Bootstrap Script
## Usage A script to bootstrap a user with git and some auxiliary tools.
### Dotfiles ## Usage
Download and run the latest `bootstrap.sh`: Download and run the latest `bootstrap.sh`:
@ -16,10 +16,12 @@ In the event that you want to simply test `bootstrap.sh`, simply pass a differen
See `bootstrap.sh -h` for more usage information. See `bootstrap.sh -h` for more usage information.
### Older Versions ## Older Versions
`build-home.sh` is an older version of the script kept here for legacy compatibility. Do not use it; use `bootstrap.sh`. `build-home.sh` is an older version of the script kept here for legacy compatibility. Do not use it; use `bootstrap.sh`.
## Notes ## Notes
* 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 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. * 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.