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

Rework README

Browse Source
This commit is contained in:
Salt 2020-08-10 23:37:20 -05:00
parent a90ade616d
commit 1119995914
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -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.