docs: correct README to JIT render path and simplify#240
Open
obj-p wants to merge 1 commit into
Open
Conversation
The dylib preview path was retired; rendering now goes through the LLVM ORC JIT executor. Update the "Why" description accordingly and add the mandatory build-jit-llvm prebuild step to Quickstart and From-source, since Package.swift now fails fast without the artifacts. Note the cmake/ninja requirement and point users at Homebrew for a no-setup path. Also simplify drifted prose: tighten the micro-apps pitch, dedupe the daemon explanation into the Daemon model section, cut the --json example block, and trim the Debugging section. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
obj-p
force-pushed
the
docs/readme-jit-drift-and-simplify
branch
from
fcea340 to
0260838
Compare
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
1 participant
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.
What
The README still described the retired dylib preview path and had drifted build instructions. It also carried some redundant/over-long prose. This is a docs-only change.
Drift fixes
#Previewclosure into the host process. Package.swift confirms the dylib path was retired.Package.swiftfails fast at manifest evaluation unlessscripts/build-jit-llvm.shandscripts/build-jit-llvm-iossim.shhave run, so a cleanswift run/swift buildwas broken as documented.cmake+ninjasource-build dependency, and Quickstart points at Homebrew as the no-setup path.Simplifications
--jsonexample block from seven lines to two.Verification
Docs-only. Verified
scripts/build-jit-llvm*.shexist, the#daemon-modelanchor resolves, and nodylibwording remains in the README.🤖 Generated with Claude Code