commit 6a90958e42496fe1a509231c0f8976278ad4aaea (patch)
parent d170a1e81ff1cfab5b04d9b40f694c4d5c9e8ffa
Author: Alex Karle <alex@karle.co>
Date: Tue, 4 Jun 2019 23:07:37 -0400
[doc] update README with safer/more accurate install instructions
Previously I simply recommended a curl-into-bash of the installer. I
have since come to realize this isn't the safest option (and respect
that I shouldn't recommend it). As such, I've updated the README to
encourage the user reads the installer.
Additionally this documents the link.sh script, which is really the
workhorse of the installer (in the sense that it alone sets up the
dotfiles, the installer just installs them and other things I want).
Diffstat:
| M | README.md | | | 30 | ++++++++++++++++++++++++++++-- |
1 file changed, 28 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -9,10 +9,36 @@ Note that the install will still download it!
## Install
-Note that bash is required for this install (as some of the interactive options depend on bash).
+For a full-featured install, with interactive use (bash required) and options to
+download my (Neo)Vim configuration along with other things I find useful, use
+the [install.sh](bin/install.sh) script:
+```sh
+# Download the installer
+curl -fsSL https://raw.githubusercontent.com/akarle/dotfiles/master/bin/install.sh > install.sh
+
+# Check it looks OK
+less install.sh
+
+# Run it!
+bash install.sh
```
-bash -c "$(curl -fsSL https://raw.githubusercontent.com/akarle/dotfiles/master/bin/install.sh)"
+
+Currently this installs:
+
+1. These dotfiles
+2. My [dotvim](https://github.com/akarle/dotvim) repo (with favorite plugins as
+ submodules)
+3. The git [bash-completion script](https://raw.githubusercontent.com/git/git/master/contrib/completion/git-completion.bash)
+
+Alternatively, should you just want these dotfiles (and nothing else
+downloaded), clone this repo and run [link.sh](link.sh) which will interactively
+(and non-destructively) link each of the dotfiles to the proper location.
+
+```sh
+git clone https://github.com/akarle/dotfiles
+chmod +x dotfiles/bin/link.sh
+./link.sh
```
## Trying it Out
