ZX: The Zomp client.

Project information can be found at https://zxq9com/zx/ and https://github.com/zxq9/zx/


ZX is delivered as a zip file containing:
- `zomp.tar.gz`: An archive of a current working zx/zomp installation
- `install.escript`: The main installation script
- `install_unix` and `install_windows.cmd`: System-specific installation starters
- `README.*` files such as this one
- `LICENSE`
- `notify.vbs`: A hacky VBS script to communicate with the Windows GUI during setup


Installation

To install ZX the `install.escript` program needs to run. In order to run it requires
an Erlang environment to be envoked via the Escript interpreter. The system-specific
installation starter scripts exist to locate the Erlang installation on the local
system.

The installer will unpack the ZX client and the relevant parts of Zomp (the package
system underlying everything) to a directory in your home directory called "zomp".
Once everything is unpacked it will add a link called `zx` to your command environment
so that you can invoke zx the normal way.

For further information about installation, consult the relevant README file in this
directory.


Features

ZX has a number of features, most of them useful to developers and testers, but the
most important feature is for users of programs. To run any program from a configured
Zomp realm you run the command:
    `zx run [program_name]`

If the version number of the program is omitted (the typical case) then the latest
version will always be installed and run. If a version number is provided then that
specific version will be installed and run.

ZX updates itself in the same manner it updates other installed programs. Occasionally
you may receive a message indicating that you should re-run ZX because a newer version
has been installed.

At the moment ZX only works from the command line, though desktop links to launchers
for GUI programs can be easily created.

To create a desktop launcher for a program the launcher must invoke zx the same way
you do from the command line:
    `zx run [program_name]`

In the event you need to write an installer for a system you have released through a
Zomp repository all the installer needs to do is provide an icon set and create a
launcher for the program that invokes zx the same way you would from the command line.

The default Zomp realm is called "otpr". It is installed automatically and contains
only FOSS software.


ZX supports fetching and resolution of multiple realms at the same time, similar to
how Linux distribution package managers usually permit configuration of multiple
repository sources. To create and host your own, possibly private or proprietary, Zomp
realm consult the Zomp documentation directly.