diff --git a/changelog b/changelog index a63821b0..fc8a5cec 100644 --- a/changelog +++ b/changelog @@ -19,6 +19,7 @@ unreleased * Allow use of specific path when running Git or any dependency * Fail if hook scripts return failure codes * Check GIT_REMOTE early on clone() + * Setup optional standalone deployment attached directly to releases 2021-04-05 Richard Hartmann diff --git a/doc/INSTALL.md b/doc/INSTALL.md index c2965e63..68e1cc07 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -2,6 +2,7 @@ Many distributions have packages ready to go. If yours doesn't, you can install [from source](#installing-from-source). +VCSH can also be deployed as a [standalone script](#standalone-script). If you package VCSH for a distro please let us know. ## Arch Linux @@ -124,4 +125,29 @@ $ make DESTDIR="$HOME" install-exec This will install to `~/bin/vcsh`; add `~/bin` to your path to use. +# Standalone Script + +A special variant of VCSH can be deployed as a single POSIX script with no configure/build step. +Deploying it this way leave you without any man page or shell completion functions. +This variant is also dependent or you `$PATH` to have proper versions of dependencies such as `git`. +If your user space has different tools by default than your system beware! + +The standalone variant can be downloaded from under any entry in [releases](https://github.com/RichiH/vcsh/releases). + +This method is suited for installation to a user space where you don't have control over the system packages, e.g.: + +```console +$ mkdir ~/bin +$ curl -fsLS https://github.com/RichiH/vcsh/releases/latest/download/vcsh-standalone.sh -O ~/bin/vcsh +$ chmod 755 ~/bin/vcsh +``` + +It could also be used to directly bootstrap a dotfiles repository something like this: + +```console +$ sh <(curl -fsLS https://github.com/RichiH/vcsh/releases/latest/download/vcsh-standalone.sh) clone dotfiles +``` + +Note that we strongly encourage using a tagged version that you've tested to work for you instead of the *latest* keyword. + [1]: http://rtomayko.github.io/ronn/