Skip to content

Commit a3f38ed

Browse files
committed
docs: make README user install release-only
1 parent 2fbc823 commit a3f38ed

1 file changed

Lines changed: 22 additions & 22 deletions

File tree

README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
11
# Codex Desktop for Linux
22

3-
Unofficial Linux packaging workflow for Codex Desktop with support for **Debian APT** and **AppImage**.
3+
Unofficial Linux packaging for Codex Desktop.
44

5-
## Public Installation
5+
## User Installation (Release Only)
66

7-
### Debian / Ubuntu (APT Repository)
7+
End users only need files from **GitHub Releases**.
8+
No need to clone this repo or install Node.js.
89

9-
After you publish a release tag, users can install with:
10+
Release page: https://github.com/cuongducle/codex-linux/releases/latest
1011

11-
```bash
12-
# One-command installer
13-
curl -fsSL https://<owner>.github.io/<repo>/install.sh | sudo bash
14-
15-
# Or manual setup
16-
echo "deb [trusted=yes] https://<owner>.github.io/<repo>/ stable main" | sudo tee /etc/apt/sources.list.d/codex-desktop.list
17-
sudo apt update
18-
sudo apt install codex-desktop
19-
```
12+
### Option 1: Debian / Ubuntu (`.deb`)
2013

21-
Updates:
14+
1. Go to [Releases](https://github.com/cuongducle/codex-linux/releases/latest).
15+
2. Download the latest `codex-desktop-*.deb` file.
16+
3. Install:
2217

2318
```bash
24-
sudo apt update
25-
sudo apt upgrade
19+
sudo apt install ./codex-desktop-*.deb
2620
```
2721

28-
### AppImage (Any Distro)
22+
### Option 2: Any Distro (`.AppImage`)
2923

30-
Download from GitHub Releases:
24+
1. Go to [Releases](https://github.com/cuongducle/codex-linux/releases/latest).
25+
2. Download the latest `codex-desktop-*-x86_64.AppImage`.
26+
3. Run:
3127

3228
```bash
33-
wget https://github.com/<owner>/<repo>/releases/latest/download/codex-desktop-<version>-x86_64.AppImage
3429
chmod +x codex-desktop-*-x86_64.AppImage
3530
./codex-desktop-*-x86_64.AppImage
3631
```
3732

33+
### Updating
34+
35+
- `.deb`: download and install the newer release file.
36+
- `.AppImage`: replace the old AppImage with the new release file.
37+
3838
## Maintainer Flow (Build + Publish)
3939

4040
### 1) Build locally
@@ -55,7 +55,7 @@ npm run build:linux
5555

5656
Output artifacts are in `dist/`.
5757

58-
### 2) Publish public files
58+
### 2) Publish release
5959

6060
Push a version tag:
6161

@@ -100,8 +100,8 @@ That new tag triggers the release workflow, which publishes new `.deb`, `.AppIma
100100

101101
- Packaging targets: **DEB** and **AppImage** only
102102
- Linux native module rebuild (`better-sqlite3`, `node-pty`)
103-
- Auto-publish APT repo on release tag
104-
- Auto-upload AppImage to GitHub Releases
103+
- Auto-upload release artifacts (`.deb`, `.AppImage`) to GitHub Releases
104+
- Optional APT repo publish on release tag
105105

106106
## Repository Structure
107107

0 commit comments

Comments
 (0)