From 6af942814f4cf9c7442b39279baaf27765e2820d Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Thu, 27 May 2021 23:14:32 +0200 Subject: [PATCH 1/3] Fix some typos in the README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ac603e6..e982424 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 @@ -56,7 +56,7 @@ If you want to connect an Appservice to Conduit, take a look at the [Appservice 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): From 0f16a79888f38db46167ee214fe1d57bfcd4f666 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Thu, 27 May 2021 23:13:50 +0200 Subject: [PATCH 2/3] Specify the minimum required Rust version in the manifest Also mention it in the deployment guide. --- Cargo.toml | 1 + DEPLOY.md | 9 ++++++++- 2 files changed, 9 insertions(+), 1 deletion(-) 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..f26feaa 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,13 @@ $ 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. + + ## Adding a Conduit user While Conduit can run as any user it is usually better to use dedicated users for different services. From f199b51f9795e7a58192221cd2902990efb94bab Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Fri, 28 May 2021 09:42:59 +0200 Subject: [PATCH 3/3] Move the link to cross-compiling guide to DEPLOY.md --- DEPLOY.md | 1 + README.md | 2 -- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/DEPLOY.md b/DEPLOY.md index f26feaa..fe8c331 100644 --- a/DEPLOY.md +++ b/DEPLOY.md @@ -24,6 +24,7 @@ $ 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 diff --git a/README.md b/README.md index e982424..e856dd5 100644 --- a/README.md +++ b/README.md @@ -54,8 +54,6 @@ 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). - ##### 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):