-
Notifications
You must be signed in to change notification settings - Fork 0
Restore empty Homebrew install guide content #65
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # Installing RegShape with Homebrew | ||
|
|
||
| RegShape is distributed through a [Homebrew](https://brew.sh) tap so you can | ||
| install and update the CLI with a single command on macOS and Linux. | ||
|
|
||
| ## Install | ||
|
|
||
| ```bash | ||
| brew install toddysm/regshape/regshape | ||
| ``` | ||
|
|
||
| This automatically taps `toddysm/regshape` and installs the `regshape` formula. | ||
| You can also tap explicitly first: | ||
|
|
||
| ```bash | ||
| brew tap toddysm/regshape | ||
| brew install regshape | ||
| ``` | ||
|
|
||
| Verify the installation: | ||
|
|
||
| ```bash | ||
| regshape --version | ||
| regshape --help | ||
| ``` | ||
|
|
||
| ## Upgrade | ||
|
|
||
| ```bash | ||
| brew update | ||
| brew upgrade regshape | ||
| ``` | ||
|
|
||
| ## Uninstall | ||
|
|
||
| ```bash | ||
| brew uninstall regshape | ||
| brew untap toddysm/regshape | ||
| ``` | ||
|
|
||
| ## How it works | ||
|
|
||
| - The formula lives in the [toddysm/homebrew-regshape](https://github.com/toddysm/homebrew-regshape) | ||
| tap repository. | ||
| - RegShape is installed into an isolated Python virtualenv with pinned | ||
| dependency resources, so it does not interfere with your system Python. | ||
| - On every RegShape release, the project's release workflow publishes the new | ||
| version to PyPI and then opens a pull request in the tap to bump the formula | ||
| (source URL and checksum) to match. Once that PR is merged, `brew upgrade` | ||
| picks up the new version. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| - **`Error: No available formula`** — run `brew update` and ensure the tap is | ||
| present with `brew tap`. | ||
|
toddysm marked this conversation as resolved.
Outdated
|
||
| - **Stale version after a release** — the formula bump PR in the tap may not be | ||
| merged yet; check the [tap pull requests](https://github.com/toddysm/homebrew-regshape/pulls). | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.