From 39a1b4b225d4dd241e5c255690f7ae9085aa7a07 Mon Sep 17 00:00:00 2001 From: ssrlive <30760636+ssrlive@users.noreply.github.com> Date: Thu, 14 Mar 2024 21:51:07 +0800 Subject: [PATCH] minor changes --- Cargo.toml | 1 + build-apple.sh | 2 ++ readme-cn.md | 13 +++++++++++++ readme.md | 12 ++++++++++++ 4 files changed, 28 insertions(+) diff --git a/Cargo.toml b/Cargo.toml index e73a53d..82b328f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,6 +4,7 @@ version = "0.2.13" edition = "2021" license = "MIT" description = "A simple proxy tunnel, minimalist tool for bypassing the GFW." +repository = "https://github.com/ShadowsocksR-Live/overtls" [lib] crate-type = ["staticlib", "cdylib", "lib"] diff --git a/build-apple.sh b/build-apple.sh index bf005b1..929b150 100755 --- a/build-apple.sh +++ b/build-apple.sh @@ -4,6 +4,8 @@ echo "Setting up the rust environment..." rustup target add aarch64-apple-ios aarch64-apple-ios-sim x86_64-apple-ios x86_64-apple-darwin aarch64-apple-darwin cargo install cbindgen +cargo update + echo "Building..." cargo build --release --target x86_64-apple-darwin cargo build --release --target aarch64-apple-darwin diff --git a/readme-cn.md b/readme-cn.md index 1b56d1f..2c8043a 100644 --- a/readme-cn.md +++ b/readme-cn.md @@ -37,14 +37,27 @@ overtls 客戶端首先與 overtls 服務端建立 TLS 連接,然後 overtls ## 安裝 +### 從 crates.io 安裝 + +如果你已經安裝了 [Rust](https://rustup.rs/),你可以直接安裝 overtls。 + +```bash +cargo install overtls +``` + +### 預編譯二進制文件 + 可直接從源代碼編譯,也可以從 [發布頁面](https://github.com/shadowsocksr-live/overtls/releases) 下載預編譯的二進制文件。 +### 從源碼編譯 + 從源碼編譯,需要先安裝 [Rust](https://www.rust-lang.org/) 編程語言環境,然後執行以下命令編譯軟件。 ```bash git clone https://github.com/shadowsocksr-live/overtls.git cd overtls cargo build --release +sudo cp target/release/overtls /usr/local/bin/ ``` ### 服務端一鍵安裝腳本 diff --git a/readme.md b/readme.md index f1c6527..287079a 100644 --- a/readme.md +++ b/readme.md @@ -51,9 +51,20 @@ In summary, we need to prepare the following things ## Installation +### Install from crates.io + +If you have installed the [Rust](https://rustup.rs/), you can install overtls directly. +```bash +cargo install overtls +``` + +### Pre-compiled binary file + Can be compiled directly from the source code, or you can download the pre-compiled binary file from the [Release page](https://github.com/shadowsocksr-live/overtls/releases). +### Compile from source code + To compile from source code, you need to install the [Rust](https://www.rust-lang.org/) programming language environment first, and then run the following commands to compile overtls. @@ -61,6 +72,7 @@ programming language environment first, and then run the following commands to c git clone https://github.com/shadowsocksr-live/overtls.git cd overtls cargo build --release +sudo cp target/release/overtls /usr/local/bin/ ``` ## Server-side one-click installation script