Skip to content

Commit 4464de8

Browse files
authored
docs: add Linux build-time deps to cargo install guides (#3270)
1 parent 14ac031 commit 4464de8

7 files changed

Lines changed: 38 additions & 0 deletions

File tree

README.ja-JP.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ cargo install codewhale-cli --locked
2727
cargo install codewhale-tui --locked
2828
```
2929

30+
> **Linux ユーザーへ:** ビルド依存パッケージを先にインストールしてください:
31+
> `sudo apt-get install -y build-essential pkg-config libdbus-1-dev`
32+
> 詳細は [INSTALL.md](docs/INSTALL.md#4-install-via-cargo-any-tier-1-rust-target) を参照。
33+
3034
その他の経路:
3135

3236
```bash

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ cargo install codewhale-cli --locked
3232
cargo install codewhale-tui --locked
3333
```
3434

35+
> **Linux users:** install system build dependencies first:
36+
> `sudo apt-get install -y build-essential pkg-config libdbus-1-dev`.
37+
> See [INSTALL.md](docs/INSTALL.md#4-install-via-cargo-any-tier-1-rust-target).
38+
3539
Every other path:
3640

3741
```bash

README.vi.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ cargo install codewhale-cli --locked
3333
cargo install codewhale-tui --locked
3434
```
3535

36+
> **Người dùng Linux:** cài đặt các gói build trước:
37+
> `sudo apt-get install -y build-essential pkg-config libdbus-1-dev`.
38+
> Xem [INSTALL.md](docs/INSTALL.md#4-install-via-cargo-any-tier-1-rust-target).
39+
3640
Mọi đường cài đặt khác:
3741

3842
```bash

README.zh-CN.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ cargo install codewhale-cli --locked
3232
cargo install codewhale-tui --locked
3333
```
3434

35+
> **Linux 用户注意:** 请先安装系统构建依赖:
36+
> `sudo apt-get install -y build-essential pkg-config libdbus-1-dev`
37+
> 详见 [INSTALL.md](docs/INSTALL.md#4-install-via-cargo-any-tier-1-rust-target)
38+
3539
如果访问 GitHub 不稳定,推荐直接走下面的 CNB 镜像。其他安装路径:
3640

3741
```bash

docs/CNB_MIRROR.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,9 @@ behind GitHub-blocking networks should use one of these paths:
169169
```
170170
(Both binaries are required — the dispatcher and the TUI ship
171171
separately; see `AGENTS.md` for the two-binary install rationale.)
172+
Linux build-time dependencies (`build-essential`, `pkg-config`,
173+
`libdbus-1-dev` on Debian/Ubuntu) are required — see
174+
[INSTALL.md](INSTALL.md#4-install-via-cargo-any-tier-1-rust-target).
172175

173176
- **CNB release assets** for Linux x64, when the matching CNB tag pipeline has
174177
completed successfully. Download `codewhale-linux-x64`,

docs/INSTALL.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,24 @@ cargo install codewhale-tui --locked # provides `codewhale-tui`
158158
codewhale --version
159159
```
160160
161+
> **Linux: install build-time dependencies first.** `cargo install` compiles
162+
> from source, and on Linux the `codewhale-tui` crate links against
163+
> `libdbus-1` (used by the D-Bus secret-service backend for credential
164+
> storage). Install the required system packages before running `cargo install`:
165+
>
166+
> ```bash
167+
> # Debian / Ubuntu
168+
> sudo apt-get install -y build-essential pkg-config libdbus-1-dev
169+
>
170+
> # Fedora / RHEL
171+
> sudo dnf install -y gcc make pkgconf-pkg-config dbus-devel
172+
> ```
173+
>
174+
> If you use the npm wrapper or download GitHub Release binaries, these
175+
> build-time packages are **not** required — the prebuilt binary only
176+
> needs the runtime library (`libdbus-1`), which is already present on
177+
> most desktop Linux installs.
178+
161179
### China / mirror-friendly install
162180
163181
When installing from mainland China, configure mirrors for both **rustup**

scripts/tencent-lighthouse/bootstrap-ubuntu.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ apt-get install -y \
2525
openssh-client \
2626
build-essential \
2727
pkg-config \
28+
libdbus-1-dev \
2829
libssl-dev \
2930
nodejs \
3031
npm \

0 commit comments

Comments
 (0)