From 0c3a72be37e1a06ffb6e50170c01775576b3e63e Mon Sep 17 00:00:00 2001 From: Craig Everett Date: Mon, 20 Jan 2020 23:39:10 +0900 Subject: [PATCH] Align readme to docs --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f1c994c..97c31d9 100644 --- a/README.md +++ b/README.md @@ -21,20 +21,18 @@ Read the [docs](http://zxq9.com/projects/zomp/) for more. [https://gitlab.com/zxq9/zx/](https://gitlab.com/zxq9/zx/) # Installation + +## Detailed information For installation information see the [installation page](https://zxq9.com/projects/zomp/qs.install.en.html). -## Linux/BSD/OSX/*nix: -1. Have an Erlang runtime installed. -2. Download the [tarball](https://zxq9.com/projects/zomp/download.en.html). -3. `tar -Jxf zx-[version].tar.xz` -(or `tar -zxf zx-[version].tar.gz`) -4. `cd zx-[version]` -5. Make the `install` script executable and run it. +## TL;DR -To uninstall make the `uninstall` script executable and run it. +### Linux/BSD/OSX/*nix: +1. Have an Erlang runtime installed. +2. Do `wget -q https://zxq9.com/projects/zomp/get_zx && bash get_zx` *NOTE: To roll a unix installation bundle from this repo run the `packup` script. It will generate `zx-[version].tar.xz` (Linux) and `zx-[version].tar.gz` (OSX, BSD, etc.) bundles.* -## Windows: +### Windows: Download the Windows installer from the [download page](https://zxq9.com/projects/zomp/download.en.html).