From cfb778ea6436d7715a30d688e65c5a26e33f5b95 Mon Sep 17 00:00:00 2001 From: undef-i Date: Sat, 18 Mar 2023 18:50:13 +0800 Subject: [PATCH] Release v0.0.1 --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 244c6cf..30899ee 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ OPTIONS: -h, --help Print help information ``` ## Quick Start -0. Make sure that Bird and Traceroute are installed and available. -1. Obtain the binary executable by either downloading it from the release or compiling the project with Cargo. -2. Use the command bird-looking-glass-proxy --example > config.toml to create a template configuration file and modify it to your needs. +0. Make sure that `bird` and `traceroute` are installed and available. +1. Obtain the binary executable by either downloading it from the release or compiling the project with `cargo`. +2. Use the command `bird-looking-glass-proxy --example > config.toml` to create a template configuration file and modify it to your needs. 3. Run the executable. ### Tips The default configuration file is located at `./config.toml`, but you can customize the file location using the `-c` or `--config` parameter. ## Known issues. -* Versions built with the *-unknown-linux-gnu toolchain may not function correctly on systems with GLIBC versions below 2.35. To resolve this, use a statically linked version built with the *-unknown-linux-musl toolchain. \ No newline at end of file +* Versions built with the `*-unknown-linux-gnu` toolchain may not function correctly on systems with `GLIBC` versions below `2.35`. To resolve this, use a statically linked version built with the `*-unknown-linux-musl` toolchain. \ No newline at end of file