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
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ jobs:
$scripts = @(
"apps/tray/start-tray.ps1",
"scripts/start-beauticode-engine.ps1",
"scripts/install-desktop-shortcut.ps1"
"scripts/install-desktop-shortcut.ps1",
"scripts/build-windows-installer.ps1"
)
foreach ($script in $scripts) {
$tokens = $null
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ coverage/
apps/tray/node_modules/
packages/*/dist/
packages/*/node_modules/
artifacts/
37 changes: 33 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ beautiCode 可以让你:

> 不是逃离工作,而是给漫长的工作过程,留一点属于自己的空间。

### v0.1 安装包

想直接使用 beautiCode,可以下载 [Windows 安装包](https://github.com/starsstreaming/beautiCode/releases/tag/v0.1)。
安装包自带运行时,不需要另外安装 Node.js 或 npm;使用前请先安装 Codex Desktop。



---
Expand Down Expand Up @@ -152,18 +157,42 @@ Ctrl + Shift + Space

## 使用方式

### 运行托盘程序
### Windows 安装包(推荐)

运行:

```text
beautiCode-Setup-0.1.0-win-x64.exe
```

安装包自带 Node.js 运行时。使用者不需要安装 Node.js、npm,也不需要保留
项目源码。安装完成后启动 beautiCode,Windows 右下角会出现托盘图标;
如果 Codex Desktop 尚未启动,引擎会尝试启动并连接它。

目前版本需要安装 Node.js 22 或更高版本。
当前安装包尚未进行商业代码签名,Windows 可能显示 SmartScreen 提示。
用户导入的图片、视频和已保存主题位于
`%LOCALAPPDATA%\beautiCode`,卸载程序默认保留这些数据。

在项目目录执行:
### 从源码运行

源码开发需要 Node.js 22 或更高版本。在项目目录执行:

```bash
npm install
npm run tray
```

启动后,Windows 右下角会出现 beautiCode 托盘图标。
构建 Windows 安装包:

```powershell
npm run installer:windows
```

输出位于:

```text
artifacts\windows\installer\
```

通过托盘菜单可以:

Expand Down
Loading
Loading