zx/README.md

35 lines
1.4 KiB
Markdown

# ZX: The Zomp client
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
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.
If you have ZX on your system, `zx run [program name]` will launch a program.
`zx create project` will start a project for you.
Read the [docs](http://zxq9.com/projects/zomp/) for more.
## Docs
[http://zxq9.com/projects/zomp/](http://zxq9.com/projects/zomp/)
## Code
[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).
## 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.
## Windows:
Download the Windows installer from the [download page](https://zxq9.com/projects/zomp/download.en.html).