diff --git a/README.md b/README.md index 42adc11..7b0459f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ -# zmx-client +# ZMatrix Client +A native GUI client for the ZMatrix collection of projects. +Implements a client for the Matrix protocol. +# Building +Clone the repository +```sh +git clone https://gitea.itycodes.org/itycodes/zmx-client.git +``` +Make a config file, filling the homeserver, user, and password fields: +```json +{ + "homeserver": "itycodes.org", + "user": "ity", + "password": "ilovecookies" +} +``` +Run `cargo run` for testing right away, or `cargo build` to build a debug build, or `cargo build --release` for a release build. + +Builds will be in `target/debug/mxclient` or `target/release/mxclient`, for debug and release builds respectively. + +[More details](https://nnethercote.github.io/perf-book/build-configuration.html)