Skip to content

docs(readme): explain release asset choices - #9

Merged
bao-cn merged 1 commit into
mainfrom
docs/release-assets
Aug 16, 2026
Merged

docs(readme): explain release asset choices#9
bao-cn merged 1 commit into
mainfrom
docs/release-assets

Conversation

@bao-cn

@bao-cn bao-cn commented Aug 16, 2026

Copy link
Copy Markdown
Owner

Summary

  • Explain the differences between the custom standalone archive, source archive, checksum file, and GitHub-generated source archives.
  • Add a Linux x64 standalone quick-deployment path and a source-build path for Windows, macOS, ARM64, and customization.
  • Clarify which source archive should be used for Docker deployment.

Motivation

Release users need clear guidance on which asset matches their platform and whether they must build the application locally.

Implementation

The Chinese and English deployment sections now include an asset comparison table, current-release commands, checksum verification, platform compatibility notes, and separate manual deployment workflows.

Behavior and compatibility

Documentation only. Runtime behavior, configuration, APIs, and stored data are unchanged.

Risk

Low. The documented Linux x64 limitation makes the native dependency compatibility boundary explicit.

Verification

The following checks passed:

npx prettier --check README.md README.en.md
git diff --check

Checklist

  • I read and followed CONTRIBUTING.md.
  • The change is focused and does not include unrelated formatting, dependency, or generated-file churn.
  • I updated README documentation where necessary.
  • This Pull Request contains no passwords, tokens, private articles, databases, environment files, Agent instructions, or production data.

@bao-cn
bao-cn merged commit f3fc038 into main Aug 16, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant