pharpend/zx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Align readme to docs

Browse Source
This commit is contained in:
Craig Everett 2020-01-20 23:39:10 +09:00
parent e473cdafc3
commit 0c3a72be37
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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).