Update README to match current setup - #16
Merged
Merged
Conversation
The previous README was stale (v0.0.1, incremental rebuilds, missing SWBBuildServiceBundle) and used em dashes. Rewrite from the current CLI, config, and watcher behavior.
butterbearbear
changed the title
TyZh0928
approved these changes
Aug 21, 2026
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 free
to 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.
Description
Update the README so it matches the current CLI,
buildServer.jsonfields, and workspace watcher.People installing from source now copy
SWBBuildServiceBundlenext to the binary.initdocuments its real defaults: detected.xcworkspaceor.xcodeproj,iphonesimulator, andargvset to the binary that ran. The watcher is described as a project-metadata reload (project.pbxproj,Package.resolved), not an incremental rebuild.The page is shorter: install, setup, config, and troubleshooting stay, without a separate features list, CLI reference, or project layout.
Verification steps
initdefaults, and the source-install copy step look right