docs: add Homebrew install instructions#8
Merged
Conversation
mlx-server now ships a Homebrew formula. Add an Install section leading with 'brew install defilantech/tap/mlx-server' and rename the former 'Build and run' section to 'Build from source', since building from source is now the alternative path, not the only one. Signed-off-by: Christopher Maher <chris@mahercode.io>
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
Adds an
Installsection to the README leading withbrew install defilantech/tap/mlx-server, and renames the formerBuild and runsection toBuild from source.Why
mlx-server now ships a Homebrew formula (
defilantech/homebrew-tap), so a one-linebrew installis the expected install path. The README previously documented only thexcodebuildfrom-source build, which is now the alternative, not the only option.How
## Installsection: thebrew installcommand, the platform requirement, a link to the releases page, and the run command.## Build and runrenamed to## Build from source. No anchors elsewhere in the README referenced the old heading.