mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-07-23 21:38:44 +08:00
docs: clarify and fix desktop build instructions (#12881)
This PR changes documentation files related to building the desktop client app to allow other contributors to develop and test without becoming stuck due to outdated docs. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Improved build instructions for native dependencies and E2E testing, including updated commands and clearer server startup steps. - Enhanced desktop client app documentation with clarified build steps, corrected artifact paths, and added Linux installation guidance. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
@@ -37,6 +37,8 @@ On Windows, you must enable symbolic links this code repo. See [#### Windows](./
|
||||
|
||||
## Build, package & make the desktop client app
|
||||
|
||||
> repos/AFFiNE/.github/workflows/release-desktop.yml contains real order to build the desktop client app, but here we will explain the steps in a more detailed way. Up-to date.
|
||||
|
||||
### 0. Build the native modules
|
||||
|
||||
Please refer to `Build Native Dependencies` section in [BUILDING.md](./BUILDING.md#Build-Native-Dependencies) to build the native modules.
|
||||
@@ -46,6 +48,8 @@ Please refer to `Build Native Dependencies` section in [BUILDING.md](./BUILDING.
|
||||
On Mac & Linux
|
||||
|
||||
```shell
|
||||
BUILD_TYPE=canary yarn affine @affine/electron build
|
||||
|
||||
BUILD_TYPE=canary yarn affine @affine/electron generate-assets
|
||||
```
|
||||
|
||||
@@ -110,7 +114,7 @@ Once the build is complete, you can find the paths to the binaries in the termin
|
||||
|
||||
```
|
||||
Finished 2 bundles at:
|
||||
› Artifacts available at: <affine-repo>/packages/frontend/electron/out/make
|
||||
› Artifacts available at: <affine-repo>/packages/frontend/apps/electron/out/canary/make
|
||||
```
|
||||
|
||||
## CI
|
||||
|
||||
Reference in New Issue
Block a user