homebrew-cask/README.md

75 lines
3.7 KiB
Markdown
Raw Normal View History

# Homebrew Cask
_“To install, drag this icon…” no more!_
2013-04-05 16:10:59 +08:00
Homebrew Cask extends [Homebrew](https://brew.sh) and brings its elegance, simplicity, and speed to the installation and management of GUI macOS applications such as Atom and Google Chrome.
We do this by providing a friendly CLI workflow for the administration of macOS applications distributed as binaries.
[![Join us on https://discourse.brew.sh](https://img.shields.io/badge/Discourse-forum-blue.svg)](https://discourse.brew.sh)
2015-09-07 21:23:51 +08:00
## Lets try it!
2015-09-16 06:24:11 +08:00
To start using Homebrew Cask, you just need [Homebrew](https://brew.sh/) installed.
2015-12-22 20:33:44 +08:00
<img src="https://i.imgur.com/bjr8UxZ.gif" width="547" alt="Installing and uninstalling Atom (animated gif)">
2015-09-16 06:24:11 +08:00
Slower, now:
2015-09-16 06:24:11 +08:00
```
$ brew cask install atom
==> Satisfying dependencies
==> Downloading https://github.com/atom/atom/releases/download/v1.35.1/atom-mac.zip
==> Downloading from https://github-production-release-asset-2e65be.s3.amazonaws.co
######################################################################## 100.0%
==> Verifying SHA-256 checksum for Cask 'atom'.
==> Installing Cask atom
==> Moving App 'Atom.app' to '/Applications/Atom.app'.
==> Linking Binary 'apm' to '/usr/local/bin/apm'.
==> Linking Binary 'atom.sh' to '/usr/local/bin/atom'.
🍺 atom was successfully installed!
```
And there we have it. Atom installed with one quick command: no clicking, no dragging, no dropping.
2015-09-16 06:24:11 +08:00
2016-01-11 21:56:20 +08:00
## Learn More
* Find basic documentation on using Homebrew Cask in [USAGE.md](USAGE.md)
2015-09-16 06:24:11 +08:00
* Want to contribute a Cask? Awesome! See [CONTRIBUTING.md](CONTRIBUTING.md)
2016-01-23 13:14:24 +08:00
* Want to hack on our code? Also awesome! See [hacking.md](doc/development/hacking.md)
2016-01-15 09:57:32 +08:00
* More project-related details and discussion are available in the [documentation](doc)
## Reporting bugs
[**If you ignore this guide, your issue may be closed without review**](doc/faq/closing_issues_without_review.md).
2019-01-25 00:15:27 +08:00
Before reporting a bug, run `brew update-reset && brew update` and try your command again. This is a fix-all that will reset the state of all your taps, ensuring the problem isnt an outdated setup on your side.
2019-01-25 00:15:27 +08:00
If your issue persists, [search for it](https://github.com/Homebrew/homebrew-cask/search?type=Issues) before opening a new one. If you find an open issue and have any new information, add it in a comment. If you find a closed issue, try the solutions there.
2019-01-25 00:15:27 +08:00
If the issue is still not solved, see the guides for common problems:
2013-09-23 02:37:18 +08:00
2019-01-25 00:15:27 +08:00
* [Examples of common errors and their solutions](doc/reporting_bugs/error_examples.md)
* [`curl` error](doc/reporting_bugs/curl_error.md)
* [`Permission denied` error](doc/reporting_bugs/permission_denied_error.md)
* [`Checksum does not match` error](doc/reporting_bugs/checksum_does_not_match_error.md)
* [`source is not there` error](doc/reporting_bugs/source_is_not_there_error.md)
* [`wrong number of arguments` error](doc/reporting_bugs/wrong_number_of_arguments_error.md)
* [The app cant be opened because it is from an unidentified developer](doc/faq/the_app_cant_be_opened.md)
* [My problem isnt listed](https://github.com/Homebrew/homebrew-cask/issues/new?template=01_bug_report.md)
## 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/master/CONTRIBUTING.md#adding-a-cask).
2018-05-22 03:21:38 +08:00
* For a feature request, [use this template](https://github.com/Homebrew/homebrew-cask/issues/new?template=02_feature_request.md).
## Questions? Wanna chat?
Were really rather friendly! Here are the best places to talk about the project:
2015-12-10 22:47:04 +08:00
* [Open an issue](https://github.com/Homebrew/homebrew-cask/issues/new/choose).
* Join us on [discourse.brew.sh (forum)](https://discourse.brew.sh)
2016-01-11 19:37:41 +08:00
## License
Code is under the [BSD 2 Clause (NetBSD) license](LICENSE)