From a490e3f868b775ad09659fdfde9516d56a7257fb Mon Sep 17 00:00:00 2001 From: Serge Guzik Date: Sat, 16 Feb 2019 21:12:03 +0200 Subject: [PATCH] docs: Make separate INSTALL document --- INSTALL.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 22 +++------------------- 2 files changed, 47 insertions(+), 19 deletions(-) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..636d00b --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,44 @@ +# Install + +Here are several more ways to install `warp4j`. + +## Manual + +First install [warp-packer](https://github.com/dgiagio/warp/releases) and ensure other common tools available: `awk`, `curl`, `file`, `grep`, `sed`, `sort`, `tar`, `unzip`, optional: `zip`. Then install `warp4j` like this: + +``` +$ LOCATION=/usr/local/bin \ +LINK=https://raw.githubusercontent.com/guziks/warp4j/master/warp4j \ +TEMP_LOCATION=/tmp/warp4j \ +bash -c 'curl -fsSL -o $TEMP_LOCATION $LINK && \ +sudo install -D \ + --mode=755 \ + --owner=root \ + --group=root \ + "$TEMP_LOCATION" "$LOCATION"' +``` + +Previous command can be also used to upgrade to the latest version. + +## Docker + +``` +$ docker run --rm -it \ + -e "WARP4J_CACHE=/cache" \ + --volume :/cache \ + --volume :/workdir \ + --user $(id -u):$(id -g) \ + guziks/warp4j +``` + +Change according to your requirements, but volume with working directory is mandatory. + +## Moor + +To simplify the command above make a launcher with [moor](https://github.com/guziks/moor): + +``` +$ moor guziks/warp4j warp4j +``` + +Then use as an ordinary command. diff --git a/README.md b/README.md index fbc0270..2bd0181 100644 --- a/README.md +++ b/README.md @@ -17,31 +17,15 @@ Just put both `warp4j` and `warp-packer` somewhere in your PATH and run `warp4j ## Install -### One-liner - -Installs latest versions of both `warp4j` and `warp-packer`: +Curl one-liner installs latest versions of both `warp4j` and `warp-packer`: ``` $ bash -c "$(curl -fsSL https://raw.githubusercontent.com/guziks/warp4j/master/install)" ``` -### Manual +This script will show missing dependencies (if there are any), they must be installed with your package manager. -First install [warp-packer](https://github.com/dgiagio/warp/releases) and ensure other common tools available: `awk`, `curl`, `file`, `grep`, `sed`, `sort`, `tar`, `unzip`, optional: `zip`. Then install `warp4j` like this: - -``` -$ LOCATION=/usr/local/bin \ -LINK=https://raw.githubusercontent.com/guziks/warp4j/master/warp4j \ -TEMP_LOCATION=/tmp/warp4j \ -bash -c 'curl -fsSL -o $TEMP_LOCATION $LINK && \ -sudo install -D \ - --mode=755 \ - --owner=root \ - --group=root \ - "$TEMP_LOCATION" "$LOCATION"' -``` - -Previous command can be also used to upgrade to the latest version. +See more install methods [here](INSTALL.md). ## Usage