Uh oh!
There was an error while loading. Please reload this page.
docs: rewrite README around a Linux-first setup path - #176
Merged
Conversation
The README assumed contributors would figure out the Linux requirement on their own, which left macOS and Windows users guessing at a workflow that only works in Linux. Restructure it around that constraint: - Lead with what Intermesh is before jumping into contributor setup - State the Linux requirement up front and give a container path for macOS/Windows (mount the repo and the Docker socket) - Add a prompt-driven setup section for assistant-guided installs, covering the non-obvious bits: BuildKit for the e2e image build, docker CLI and compose inside the dev container, and a UTF-8 locale for the Ruby lints - Set time expectations on the first cargo local run so long silent stretches are not mistaken for a hang - Collect the recurring setup failures into Common Gotchas
Restore the inline comments the old README had on the e2e and VM command blocks, and spell out that cargo test takes a name filter.
Note that package names vary by distro, flag that the first sandbox bring-up is not instant, and reword the opening paragraph.
pcnofelt
commented
Jul 27, 2026
CollaboratorAuthor
I don't know how we should handle outreach so I included the line
Prob not the best path but couldn't think of another one (discord invite?). Feel free to change. |
Bring back the host Incus sanity commands from the old README so contributors can confirm their daemon can launch VMs before running the suite.
ejj
approved these changes
Jul 30, 2026
Uh oh!
There was an error while loading. Please reload this page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrites the README around the fact that Intermesh only builds and tests on Linux, with a container path for macOS and Windows. Also adds a paste-in LLM prompt that walks people through getting a working dev environment up.