homebrew-bigsur/homebrew-cask
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README & docs: update links

Browse Source
This commit is contained in:
Eric Knibbe
2023-09-11 14:05:20 -04:00
parent 38fbb71fd0
commit 6e9ea5e833
5 changed files with 15 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@@ -17,20 +17,17 @@ Notice an application that's out-of-date in Homebrew Cask? In most cases, it's v
brew bump --open-pr <outdated_cask>
```
You can also follow the steps in [Adding a Cask](https://docs.brew.sh/Adding-Software-to-Homebrew) for more complicated changes.
You can also follow the steps in the documentation on [adding a cask](https://docs.brew.sh/Adding-Software-to-Homebrew#casks) for more complicated changes.
## Getting Set Up To Contribute
Follow the guide in [How to open a Homebrew pull request](https://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request#cask-related-pull-request).
Follow the guide in [How to Open a Homebrew Pull Request](https://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request#cask-related-pull-request).
## Adding a Cask
Notice an application that's not in Homebrew Cask yet? Make sure it's not yet in [Homebrew/cask-versions](https://github.com/Homebrew/homebrew-cask-versions) or [Homebrew/core](https://github.com/Homebrew/homebrew-core) (can be searched with `brew search`). Mac App Store apps can't be installed via Homebrew Cask, but check out [mas](https://github.com/mas-cli/mas) for an alternative.
With a bit of work, you can create a Cask for it. The document [Adding A Cask](https://docs.brew.sh/Adding-Software-to-Homebrew) will help you create, test, and submit a new Cask to us.
Notice an application that's not in Homebrew Cask yet? Make sure it's not yet in [homebrew/cask-versions](https://github.com/Homebrew/homebrew-cask-versions) or [homebrew/core](https://github.com/Homebrew/homebrew-core) (can be searched with `brew search`). Mac App Store apps can't be installed via Homebrew Cask, but check out [mas](https://github.com/mas-cli/mas) for an alternative.
With a bit of work, you can create a cask for it. The documentation on [adding a cask](https://docs.brew.sh/Adding-Software-to-Homebrew#casks) will help you create, test, and submit a new cask to us.
## Style guide

12
README.md
View File

@@ -6,11 +6,11 @@ Homebrew Cask extends [Homebrew](https://brew.sh) and brings its elegance, simpl
We do this by providing a friendly CLI workflow for the administration of macOS applications distributed as binaries.
[![Join us on GitHub discussions](https://img.shields.io/badge/github-discussions-informational)](https://github.com/Homebrew/discussions)
[![Join us on GitHub discussions](https://img.shields.io/badge/github-discussions-informational)](https://github.com/orgs/Homebrew/discussions/categories/casks)
## Let’s try it!
To start using Homebrew Cask, you just need [Homebrew](https://brew.sh/) installed.
To start using Homebrew Cask, you just need [Homebrew](https://brew.sh) installed.
<img src="https://i.imgur.com/FNNM6WL.gif" width="547" alt="Installing and uninstalling Alfred (animated gif)">
@@ -31,8 +31,8 @@ And there we have it. An application installed with one quick command: no clicki
## Learn More
* Find basic documentation on using Homebrew Cask in [USAGE.md](USAGE.md).
* Want to contribute a Cask? Awesome! See [CONTRIBUTING.md](CONTRIBUTING.md).
* More project-related details and discussion are available in the [documentation](doc).
* Want to contribute a cask? Awesome! See [CONTRIBUTING.md](CONTRIBUTING.md).
* More project-related details and discussion are available in the [documentation](https://docs.brew.sh/Adding-Software-to-Homebrew#casks).
## Reporting bugs
@@ -57,14 +57,14 @@ If the issue is still not solved, see the guides for common problems:
## Requests
* Issues requesting new casks will be closed. If you want a cask added to the main repositories, [submit a pull request](https://github.com/Homebrew/homebrew-cask/blob/HEAD/CONTRIBUTING.md#adding-a-cask).
* For a feature request, [use this template](https://github.com/Homebrew/homebrew-cask/issues/new?assignees=&labels=&template=02_feature_request.yml).
* For a feature request, [use this template](https://github.com/Homebrew/brew/issues/new?assignees=&labels=features&projects=&template=feature.yml).
## Questions? Wanna chat?
We’re really rather friendly! Here are the best places to talk about the project:
* [Open an issue](https://github.com/Homebrew/homebrew-cask/issues/new/choose).
* Join us on [GitHub discussions (forum)](https://github.com/Homebrew/discussions).
* Join us on [GitHub discussions (forum)](https://github.com/orgs/Homebrew/discussions/categories/casks).
## License
Code is under the [BSD 2 Clause (NetBSD) license](LICENSE).

2
USAGE.md
View File

@@ -2,7 +2,7 @@
## Frequently Used Commands
Homebrew Cask is implemented as part of Homebrew. All Homebrew Cask commands begin with `brew`, which works for both Casks and Formulae. The most frequently-used commands are:
Homebrew Cask is implemented as part of [Homebrew](https://brew.sh). All Homebrew Cask commands begin with `brew`, which works for both casks and formulae. The most frequently-used commands are:
* `install` — installs the given Cask.
* `uninstall` — uninstalls the given Cask.

2
doc/faq/closing_issues_without_review.md
View File

@@ -1,6 +1,6 @@
# If your issue was closed without review
Both the [reporting bugs section of the readme](https://github.com/Homebrew/homebrew-cask#reporting-bugs) and [the bug report issue template you need to fill before opening an issue](https://github.com/Homebrew/homebrew-cask/blob/HEAD/.github/ISSUE_TEMPLATE/01_bug_report.yml) warn that if the instructions aren’t followed, your issue may be closed without review.
Both the [reporting bugs section of the readme](https://github.com/Homebrew/homebrew-cask#reporting-bugs) and [the bug report issue template you need to fill before opening an issue](https://github.com/Homebrew/homebrew-cask/issues/new?template=01_bug_report.yml) warn that if the instructions aren’t followed, your issue may be closed without review.
You might have been redirected to this document if it was apparent to a maintainer that was the case. We worked hard on those guides to keep things running smoothly, so we ask you go back and follow them. It is OK to open a new issue for that.

6
doc/reporting_bugs/error_examples.md
View File

@@ -14,7 +14,7 @@ the problem was with the downloading itself (see how the error came from `curl`)
2. Cask is outdated.
3. A problem in your setup or connection.
[How to fix](https://docs.brew.sh/Common-Issues#cask--curl-error)
[How to fix](https://docs.brew.sh/Common-Issues#cask---curl-error)
---
@@ -28,7 +28,7 @@ Error: Permission denied - (/usr/local/Caskroom/someapp/0.1/Someapp.app, /Applic
the problem isn’t with Homebrew Cask itself, but some permissions on your system.
[How to fix](https://docs.brew.sh/Common-Issues#cask--permission-denied)
[How to fix](https://docs.brew.sh/Common-Issues#cask---permission-denied)
---
@@ -45,7 +45,7 @@ Actual: 526d747d99a93b760f7965e25a57ed61de9b93d566a0ba0c5f1c7e83719b20fd
either your download was incomplete/corrupt or the cask is outdated.
[How to fix](https://docs.brew.sh/Common-Issues#cask--checksum-does-not-match)
[How to fix](https://docs.brew.sh/Common-Issues#cask---checksum-does-not-match)
---