Skip to content

Comments

Added step to windows build and link to dev README#8448

Merged
myleshorton merged 2 commits intomainfrom
myles/dev-README
Feb 6, 2026
Merged

Added step to windows build and link to dev README#8448
myleshorton merged 2 commits intomainfrom
myles/dev-README

Conversation

@myleshorton
Copy link
Contributor

This pull request improves the documentation for developers by adding clear build instructions and reorganizing the README files. The main README now points developers to a dedicated developer README, and the steps to build and run the Windows app have been clarified.

Documentation improvements:

  • Added a "Developers" section to README.md with a link to the new README-dev.md for build instructions.
  • Renamed README-outline.md to README-dev.md and updated the Windows build instructions to clarify that the shared library should be built before running the Flutter desktop app.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request enhances the developer documentation by making build instructions more discoverable and complete. The main README now directs developers to a dedicated developer guide, and the Windows build instructions have been corrected to include a previously missing step for building the shared library.

Changes:

  • Added "Developers" section to main README linking to developer documentation
  • Clarified Windows build process by adding missing shared library build step

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
README.md Added new "Developers" section with link to README-dev.md for build instructions
README-dev.md Added step 3 to build Windows shared library before running Flutter desktop app

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@myleshorton myleshorton merged commit f9fef19 into main Feb 6, 2026
15 checks passed
@myleshorton myleshorton deleted the myles/dev-README branch February 6, 2026 16:55
atavism pushed a commit that referenced this pull request Feb 9, 2026
* Added windows build step

* Added link to dev README
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