feat: explicitly define toolchain by adding rust-toolchain.toml

This commit is contained in:
Saber Haj Rabiee
2022-08-30 12:31:43 -07:00
parent 548323e81f
commit c152ced34c
2 changed files with 24 additions and 8 deletions
+22 -8
View File
@@ -29,14 +29,34 @@ A simple, high performance relay server written in rust.
Realm can be run in a container with OCI (like Docker, Podman, Kubernetes, etc), see guides [here](readme.container.md).
## Build Guides
## Install Guides
Install **nightly** rust-toolchain with [rustup](https://rustup.rs/):
Install rust toolchain with [rustup](https://rustup.rs/):
```shell
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
Install Realm:
```shell
# Make sure you are using the latest release tag
cargo install --git=https://github.com/zhboner/realm --tag=v2.4.2
```
You can also pass `target_cpu=native` to allow more possible optimizations:
```shell
# Make sure you are using the latest release tag
RUSTFLAGS='-C target_cpu=native' cargo install --git=https://github.com/zhboner/realm --tag=v2.4.2
```
Or try to build by cloning this repository:
```shell
git clone https://github.com/zhboner/realm
```
Clone this repository:
```shell
@@ -49,12 +69,6 @@ Enter the directory and build:
cd realm && cargo build --release
```
Pass `target_cpu=native` to allow more possible optimizations:
```shell
RUSTFLAGS='-C target_cpu=native' cargo build --release
```
### Build Options
- ~~udp: enable udp relay~~ builtin.
+2
View File
@@ -0,0 +1,2 @@
[toolchain]
channel = "nightly"