diff --git a/Cargo.toml b/Cargo.toml index c310277..1488a3a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,6 +8,7 @@ repository = "https://gitlab.com/famedly/conduit" readme = "README.md" version = "0.1.0" edition = "2018" +rust = "1.50" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/DEPLOY.md b/DEPLOY.md index c48b778..fe8c331 100644 --- a/DEPLOY.md +++ b/DEPLOY.md @@ -6,7 +6,7 @@ If you run into any problems while setting up Conduit, write an email to `timo@k ## Installing Conduit -You have to download the binary that fits your machine. Run `uname -m` to see +You may simply download the binary that fits your machine. Run `uname -m` to see what you need. Now copy the right url: - x84_64: `https://conduit.rs/master/x86_64/conduit-bin` - armv7: `https://conduit.rs/master/armv7/conduit-bin` @@ -18,6 +18,14 @@ $ sudo wget -O /usr/local/bin/matrix-conduit $ sudo chmod +x /usr/local/bin/matrix-conduit ``` +Alternatively, you may compile the binary yourself using +```bash +$ cargo build --release +``` +Note that this currently requires Rust 1.50. + +If you want to cross compile Conduit to another architecture, read the [Cross-Compile Guide](CROSS_COMPILE.md). + ## Adding a Conduit user While Conduit can run as any user it is usually better to use dedicated users for different services. diff --git a/README.md b/README.md index ac603e6..e856dd5 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Yes! Just open a Matrix client ( or Element Android for example) and register on the `https://conduit.koesters.xyz` homeserver. -#### What is it build on? +#### What is it built on? - [Ruma](https://www.ruma.io): Useful structures for endpoint requests and responses that can be (de)serialized @@ -54,9 +54,7 @@ more](DEPLOY.md) If you want to connect an Appservice to Conduit, take a look at the [Appservice Guide](APPSERVICES.md). -If you want to cross compile Conduit to another architecture, read the [Cross-Compile Guide](CROSS_COMPILE.md). - -##### Deloy using a Debian package +##### Deploy using a Debian package You need to have the `deb` helper command installed that creates Debian packages from Cargo projects (see [cargo-deb](https://github.com/mmstick/cargo-deb/) for more info):