Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ AI Agent workspace for coding and knowledge work
[![GitHub release](https://img.shields.io/github/v/release/GCWing/BitFun?style=flat-square&color=blue)](https://github.com/GCWing/BitFun/releases)
[![Website](https://img.shields.io/badge/Website-openbitfun.com-6f42c1?style=flat-square)](https://openbitfun.com/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)](https://github.com/GCWing/BitFun/blob/main/LICENSE)
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS-blue?style=flat-square)](https://github.com/GCWing/BitFun)
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-blue?style=flat-square)](https://github.com/GCWing/BitFun)

</div>

Expand Down Expand Up @@ -89,7 +89,7 @@ The project is built with Rust + TypeScript for cross-platform reuse, keeping yo

| Form Factor | Supported Platforms | Status |
|---|---|---|
| **Desktop** | Windows, macOS | ✅ Supported (Tauri) |
| **Desktop** | Windows, macOS, Linux | ✅ Supported (Tauri) |
| **Remote Control** | Mobile browser, Telegram, Feishu | ✅ Supported |

---
Expand Down Expand Up @@ -124,6 +124,29 @@ pnpm run desktop:build

For more details, see the [Chinese Contributing Guide](./CONTRIBUTING_CN.md).

### Linux Build

#### Prerequisites

Install system dependencies:

```bash
# Debian/Ubuntu
sudo apt install libwebkit2gtk-4.1-dev build-essential libgtk-3-dev \
libayatana-appindicator3-dev librsvg2-dev patchelf
```

See [docs/linux-setup.md](docs/linux-setup.md) for other distributions (Arch, Fedora, etc.).

#### Build

```bash
pnpm install
pnpm run desktop:build:linux
```

Output will be in `src/apps/desktop/target/release/bundle/` (`.deb`, `.rpm`, `.AppImage`).

---

## Contributing
Expand Down
66 changes: 66 additions & 0 deletions docs/linux-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Linux Development Setup

## System Requirements

### Debian/Ubuntu

```bash
sudo apt update
sudo apt install -y \
libwebkit2gtk-4.1-dev \
build-essential \
curl \
wget \
file \
libxdo-dev \
libssl-dev \
libayatana-appindicator3-dev \
librsvg2-dev \
pkg-config \
libglib2.0-dev \
libgtk-3-dev \
patchelf
```

### Arch Linux

```bash
sudo pacman -S --needed \
webkit2gtk-4.1 \
base-devel \
curl \
wget \
file \
openssl \
appmenu-gtk-module \
libappindicator-gtk3 \
librsvg \
xdotool
```

### Fedora

```bash
sudo dnf check-update
sudo dnf install \
webkit2gtk4.1-devel \
openssl-devel \
curl \
wget \
file \
libappindicator-gtk3-devel \
librsvg2-devel \
libxdo-devel
sudo dnf group install "c-development"
```

## Verify Installation

After installing dependencies, verify with:

```bash
# Check pkg-config can find webkit2gtk-4.1
pkg-config --modversion webkit2gtk-4.1

# Expected output: version number (e.g., 2.44.0)
```
9 changes: 8 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@
"desktop:build:nsis": "cross-env-shell CI=true \"cd src/apps/desktop && tauri build --bundles nsis\"",
"desktop:build:arm64": "cross-env-shell CI=true \"cd src/apps/desktop && tauri build --target aarch64-apple-darwin --bundles dmg\"",
"desktop:build:x86_64": "cross-env-shell CI=true \"cd src/apps/desktop && tauri build --target x86_64-apple-darwin --bundles dmg\"",
"desktop:build:linux": "cross-env-shell CI=true 'cd src/apps/desktop && tauri build'",
"desktop:build:linux:deb": "cross-env-shell CI=true 'cd src/apps/desktop && tauri build --bundles deb'",
"desktop:build:linux:rpm": "cross-env-shell CI=true 'cd src/apps/desktop && tauri build --bundles rpm'",
"desktop:build:linux:appimage": "cross-env-shell CI=true 'cd src/apps/desktop && tauri build --bundles appimage'",
"installer:build": "pnpm --dir BitFun-Installer run installer:build",
"installer:build:fast": "pnpm --dir BitFun-Installer run installer:build:fast",
"installer:build:only": "pnpm --dir BitFun-Installer run installer:build:only",
Expand Down Expand Up @@ -68,5 +72,8 @@
"typescript": "~5.8.3",
"vite": "^7.0.4"
},
"packageManager": "pnpm@10.15.0+sha512.486ebc259d3e999a4e8691ce03b5cac4a71cbeca39372a9b762cb500cfdf0873e2cb16abe3d951b1ee2cf012503f027b98b6584e4df22524e0c7450d9ec7aa7b"
"packageManager": "pnpm@10.15.0+sha512.486ebc259d3e999a4e8691ce03b5cac4a71cbeca39372a9b762cb500cfdf0873e2cb16abe3d951b1ee2cf012503f027b98b6584e4df22524e0c7450d9ec7aa7b",
"dependencies": {
"pnpm": "^10.32.1"
}
}
11 changes: 11 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 10 additions & 1 deletion src/apps/desktop/tauri.conf.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,19 @@
"targets": "all",
"icon": [
"icons/icon.icns",
"icons/icon.ico"
"icons/icon.ico",
"icons/icon.png"
],
"resources": {
"../../mobile-web/dist": "mobile-web/dist"
},
"linux": {
"deb": {
"depends": [
"libwebkit2gtk-4.1-0",
"libgtk-3-0"
]
}
}
},
"app": {
Expand Down