From c650109ff2eda9a67ea5b7e138f38f320f3797df Mon Sep 17 00:00:00 2001 From: Jamjamjon <51357717+jamjamjon@users.noreply.github.com> Date: Sun, 27 Apr 2025 16:19:05 +0800 Subject: [PATCH] Update README.md --- README.md | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dda3d31..eb7a496 100644 --- a/README.md +++ b/README.md @@ -120,17 +120,43 @@ - ## 🛠️ Installation -**Note:** It is recommended to use the GitHub repository as the source, since the crates.io version may not be up-to-date. +To get started, you'll need: + +### 1. Protocol Buffers Compiler (`protoc`) +Required for building the project. [Official installation guide](https://protobuf.dev/installation/) +```shell +# Linux (apt) +sudo apt install -y protobuf-compiler + +# macOS (Homebrew) +brew install protobuf + +# Windows (Winget) +winget install protobuf + +# Verify installation +protoc --version # Should be 3.x or higher +``` + +### 2. Rust Toolchain +```shell +# Install Rust and Cargo +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh +``` + +### 3. Add usls to Your Project +Add the following to your `Cargo.toml`: ```toml [dependencies] +# Recommended: Use GitHub version usls = { git = "https://github.com/jamjamjon/usls" } -# crates.io version +# Alternative: Use crates.io version usls = "latest-version" ``` +> **Note:** **The GitHub version is recommended as it contains the latest updates.** ## ⚡ Cargo Features - **ONNXRuntime-related features (enabled by default)**, provide model inference and model zoo support: