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

Adjust readme

Browse Source
This commit is contained in:
Craig Everett 2020-01-20 16:06:29 +09:00
parent 3ed1513ea3
commit 47cd13ca71
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -3,7 +3,7 @@ ZX is four things:
1. An end-user client for the Zomp package distribution system
2. A suite of code development and packaging tools in Erlang for Erlang
3. The back-end of Vapor, the Erlang GUI launcher and app browser
3. The back-end of Vapor, an Erlang GUI launcher and app browser
4. A runtime service for Erlang programs that need resources or notifications from Zomp
ZX and Zomp are developed with ZX and hosted with Zomp, so after initial installation keeping up to date is simple.
@ -21,14 +21,20 @@ Read the [docs](http://zxq9.com/projects/zomp/) for more.
[https://gitlab.com/zxq9/zx/](https://gitlab.com/zxq9/zx/)
# Installation
For complete installation information see the [installation page](https://zxq9.com/projects/zomp/qs.install.en.html).
For installation information see the [installation page](https://zxq9.com/projects/zomp/qs.install.en.html).
## Linux/BSD/OSX/*nix:
To install this program from the current bundle make the `install_unix` script
executable and run it. ZX will expect you to have `$HOME/bin` in your $PATH,
though it can install without this (though it may not successfully update
itself after installation). To uninstall make the `uninstall_unix` script
executable and run it.
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.
To uninstall make the `uninstall` script executable and run it.
*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:
Download the Windows installer from the [download page](https://zxq9.com/projects/zomp/download.en.html).