mirror of
https://github.com/zhboner/realm.git
synced 2026-11-17 08:15:55 +00:00
feat: explicitly define toolchain by adding rust-toolchain.toml
This commit is contained in:
@@ -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.
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
[toolchain]
|
||||
channel = "nightly"
|
||||
Reference in New Issue
Block a user