Skip to content

docs: fix build commands from repository root #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jacktony2001 wants to merge 1 commit into from
Closed

docs: fix build commands from repository root #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Docs/DOCS.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,10 @@ with a C API, so a host application can link the core instead of spawning it.
This is what the iOS client needs, and it lets a Go program use Aether through
cgo.

From the repository root, enter the `aether` crate before building:

```sh
cd aether
cargo build --release # binary and both libraries
cargo build --release --bin aether # binary only
```
Expand Down
3 changes: 3 additions & 0 deletions Docs/DOCS.fa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,10 @@ aether --masque --h2 --upstream http://proxy.example:8080
به‌عنوان پروسه اجرا کند. کلاینت iOS به همین نیاز دارد، و یک برنامه‌ی Go هم
می‌تواند از راه cgo از ایتر استفاده کند.

از ریشهٔ مخزن ابتدا وارد کریت `aether` شوید:

```sh
cd aether
cargo build --release # باینری و هر دو کتابخانه
cargo build --release --bin aether # فقط باینری
```
Expand Down
13 changes: 7 additions & 6 deletions README.fa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,17 @@ aether
quiche/
```

ساخت پروژه:
ساخت پروژه از ریشهٔ مخزن:

```bash
cd aether
cargo build --release
```

فایل نهایی:
فایل نهایی در مسیر زیر ساخته می‌شود:

```text
target/release/aether
aether/target/release/aether
```

## داکر (Docker)
Expand Down Expand Up @@ -113,18 +114,18 @@ docker run -it -p 127.0.0.1:1819:1819 -v aether-data:/data aether
برنامه را بدون هیچ آرگومانی اجرا کنید و به سؤال‌ها جواب بدید:

```bash
./target/release/aether
./aether/target/release/aether
```

یا با پرچم‌ها از سؤال‌ها رد شید:

```bash
./target/release/aether --masque -4 --scan turbo --noize firewall
./aether/target/release/aether --masque -4 --scan turbo --noize firewall
```

روی ویندوز، به‌جای اون کافیه روی `run-aether.bat` (که همراه zip ریلیز میاد) دابل‌کلیک کنی — یه ترمینال باز می‌کنه، `aether.exe` رو اجرا می‌کنه، و بعدش پنجره رو باز نگه می‌داره تا هر خطایی رو بتونی بخونی.

هر سؤال یه پرچم و یه متغیر محیطی معادل داره. برای لیست کامل `./target/release/aether --help` رو بزن، یا به راهنماهای پایین‌تر مراجعه کن.
هر سؤال یه پرچم و یه متغیر محیطی معادل داره. برای لیست کامل `./aether/target/release/aether --help` رو بزن، یا به راهنماهای پایین‌تر مراجعه کن.

پس از اجرا، پراکسی SOCKS5 روی آدرس زیر در دسترس خواهد بود:

Expand Down
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,17 @@ The `quiche` repository must be placed alongside `aether`:
quiche/
```

Build:
Build from the repository root:

```bash
cd aether
cargo build --release
```

Binary:
The binary is written to:

```text
target/release/aether
aether/target/release/aether
```

## Docker
Expand Down Expand Up @@ -111,18 +112,18 @@ docker run -it -p 127.0.0.1:1819:1819 -v aether-data:/data aether
Run with no arguments and answer the prompts:

```bash
./target/release/aether
./aether/target/release/aether
```

Or skip the prompts with flags:

```bash
./target/release/aether --masque -4 --scan turbo --noize firewall
./aether/target/release/aether --masque -4 --scan turbo --noize firewall
```

On Windows, double-click `run-aether.bat` (included in the release zip) instead — it opens a terminal, runs `aether.exe`, and keeps the window open afterwards so you can read any errors.

Every prompt has a flag and an environment variable equivalent. Run `./target/release/aether --help` for the full list, or see the guides linked below.
Every prompt has a flag and an environment variable equivalent. Run `./aether/target/release/aether --help` for the full list, or see the guides linked below.

After startup, a SOCKS5 proxy will be available at:

Expand Down