Skip to content

docs: clarify source setup prerequisites and web build steps#301

Open
lezi-fun wants to merge 2 commits intoicebear0828:masterfrom
lezi-fun:master
Open

docs: clarify source setup prerequisites and web build steps#301
lezi-fun wants to merge 2 commits intoicebear0828:masterfrom
lezi-fun:master

Conversation

@lezi-fun
Copy link
Copy Markdown

@lezi-fun lezi-fun commented Apr 3, 2026

This PR makes the source installation instructions in the README a bit clearer for first-time setup.

Summary

  • added a dedicated prerequisites section
  • documented the Rust toolchain requirement more explicitly
  • documented the TLS addon build step in native/
  • added a note about running npm run build:web before using the web UI in source mode
  • slightly reorganized the installation flow for readability

Motivation

When following the source setup flow, some required steps were easy to miss, especially for first-time users. This PR tries to make those prerequisites and build steps more visible so the setup process is easier to follow.

Notes

Docs only, no functional changes.

lezi-fun added 2 commits April 3, 2026 18:08
docs: rewrite and reorganize README (CN/EN), add quick-start, build & self-check instructions
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