summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorkennycallado <kennycallado@gmail.com>2023-09-12 19:33:55 +0200
committerGitHub <noreply@github.com>2023-09-12 13:33:55 -0400
commitc2cc103a3df3c121cc5319990b184bf2916e1a14 (patch)
treed9e5bf910bc7c4e14e0ec344cdd7b10d22f964ae /README.md
parentbb1ca6d78227280a9d056575642962f98e131c72 (diff)
Script to install from the terminal (#427)
* update: move nix and docker to utils * feat: script to install from the terminal * doc: add some instructions to install from the terminal * strip the binary on release * udpate: - avoiding deprecated set-output - adds checksum files on release - remove strip step * update dockerignore * fix if checksum file exists --------- Co-authored-by: kennycallado <kennycallado@hotmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4e1cdc4..e512ef0 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,42 @@ Also see [Cargo.toml](Cargo.toml)
~# cargo install --path=. --force --root=/usr/local # /usr also works
```
+#### From pre-compiled binary
+
+Dependencies:
+- curl
+- openssl
+
+##### Latest release
+
+Installs the latest version using the default installation path (_$HOME/.local/bin/_).
+
+``` bash
+~$ bash <(curl -s https://raw.githubusercontent.com/kamiyaa/joshuto/master/utils/install.sh)
+```
+
+##### Custom Installation path
+
+Allows you to install Joshuto to a custom directory by setting the INSTALL_PREFIX variable.
+
+``` bash
+~$ INSTALL_PREFIX="$HOME" bash <(curl -s https://raw.githubusercontent.com/kamiyaa/joshuto/master/utils/install.sh)
+```
+
+##### System wide
+
+``` bash
+~# INSTALL_PREFIX="/usr/local/bin" bash <(curl -s https://raw.githubusercontent.com/kamiyaa/joshuto/master/utils/install.sh)
+```
+
+##### Specific release
+
+Installs a specific release version of Joshuto by the desired version number.
+
+``` bash
+~$ RELEASE_VER='v0.9.4' bash <(curl -s https://raw.githubusercontent.com/kamiyaa/joshuto/master/utils/install.sh)
+```
+
#### Packaging status
##### Fedora ([COPR](https://copr.fedorainfracloud.org/coprs/atim/joshuto/))