docs: macOS build/run notes and launcher scripts (draft)#60
Draft
iamcheyan wants to merge 1 commit into
Draft
Conversation
Adds operator-facing material for running the Mac build:
- b/HOWTO.md: end-to-end instructions for the macOS build path.
Covers client / server startup, port choices (AirPlay
Receiver squats on 7000, so default to 7100), known issues
(auto-login crashes on a missing font in current res/),
install_name_tool dylib fixups, and why the server build
needs brew LLVM instead of Apple Clang 17.
- b/run-client.sh / b/run-server.sh: thin wrappers that set
--res-path / --client-port and create the runtime symlinks
(map, script) before exec-ing the binary. Lets you launch
from anywhere without remembering the working-dir contract.
.gitignore: ignore the macOS build dir (b/) by default but
allow only the three operator artifacts above to be tracked.
Build outputs / third-party sources under b/ stay untracked.
Owner
|
man, you are using AI to working on this repo? really good! |
Contributor
Author
我是你的B站粉丝 |
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.
Marking as draft — happy to either polish or close based on
your preference.
Adds operator-facing material for running on macOS:
b/run-client.sh,b/run-server.sh— thin launcher wrappers.They derive paths from
\$BASH_SOURCEso they work from anycheckout location (no hardcoded user paths). Set
--res-path/
--client-portand create the runtime symlinks (map,script) before exec-ing the binary, so you can launch fromanywhere without remembering the working-dir contract.
b/HOWTO.md— end-to-end notes for the macOS build path:client+server startup, port choices (AirPlay Receiver squats
on 7000 → default to 7100), known issues (auto-login crashes
on a missing font in current
res/),install_name_tooldylib fixups, and why the server build needs brew LLVM
instead of Apple Clang 17.
.gitignore— ignore theb/build dir by default butallow only the three operator artifacts above.
Caveats / why this is a draft
b/HOWTO.mdis in Simplified Chinese and currentlycontains my absolute paths (
/Users/tetsuya/...) in commandexamples. Easy to genericise (use
\$REPO_ROOT/~); easyto translate. Just want to confirm whether you'd want this
doc in the tree at all before doing that work.
b/as a build-dir name is a personal preference. If you'drather use
build/(or document this as one of severalconventions) I can adjust.
HOWTO references the brew-LLVM workaround that build: optional MIR2X_CLIENT_ONLY and Apple Clang flags #59's
MIR2X_CLIENT_ONLYlets you avoid for client-only builds.If you'd rather not maintain platform-specific docs in-tree,
totally fine — feel free to close. I'll keep it on my fork.