dnrops
/
homebrew-cask
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
homebrew-cask/README.md

69 lines
4.3 KiB
Markdown
Raw Normal View History

readme.md: further refinements to header
2015-03-23 10:00:36 +08:00
# Homebrew-Cask
Add Bitdeli badge Add bitdeli badge to readme.
2013-08-13 05:03:06 +08:00
readme.md: further refinements to header
2015-03-23 10:00:36 +08:00
_“To install, drag this icon…” no more!_
travis badge woo
2013-04-05 16:10:59 +08:00
docs: Mac > macOS
2016-06-14 04:11:40 +08:00
Homebrew-Cask extends [Homebrew](http://brew.sh) and brings its elegance, simplicity, and speed to the installation and management of GUI macOS applications such as Google Chrome and Adium.
quick sketchy first release of code/ideas this is a first draft of an idea i've had kicking around for awhile pushing out some code so i can get a conversation started
2012-03-05 10:46:30 +08:00
docs: Mac > macOS
2016-06-14 04:11:40 +08:00
We do this by providing a friendly Homebrew-style CLI workflow for the administration of macOS applications distributed as binaries.
quick sketchy first release of code/ideas this is a first draft of an idea i've had kicking around for awhile pushing out some code so i can get a conversation started
2012-03-05 10:46:30 +08:00
(doc) Fix link to homebrew documentation
2016-04-04 01:53:16 +08:00
It’s implemented as a `homebrew` [external command](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/External-Commands.md) called `cask`.
quick sketchy first release of code/ideas this is a first draft of an idea i've had kicking around for awhile pushing out some code so i can get a conversation started
2012-03-05 10:46:30 +08:00
Update README.md Italicize slogan. Bump badges down.
2015-03-22 23:56:27 +08:00
[![Build Status](https://img.shields.io/travis/caskroom/homebrew-cask/master.svg)](https://travis-ci.org/caskroom/homebrew-cask)
[![Code Climate](https://img.shields.io/codeclimate/github/caskroom/homebrew-cask.svg)](https://codeclimate.com/github/caskroom/homebrew-cask)
[![Coverage Status](https://img.shields.io/coveralls/caskroom/homebrew-cask.svg)](https://coveralls.io/r/caskroom/homebrew-cask)
Add Gitter badge to README
2015-09-17 23:32:03 +08:00
[![Join the chat at https://gitter.im/caskroom/homebrew-cask](https://img.shields.io/badge/gitter-join%20chat-blue.svg)](https://gitter.im/caskroom/homebrew-cask)
Update README.md Italicize slogan. Bump badges down.
2015-03-22 23:56:27 +08:00
readme: typographical fixes
2015-09-07 21:23:51 +08:00
## Let’s try it!
README.md: general structure fixes
2015-09-16 06:24:11 +08:00
readme: clarify installation
2015-12-22 20:33:44 +08:00
To start using Homebrew-Cask, you just need [Homebrew](http://brew.sh/) installed.
README.md: general structure fixes
2015-09-16 06:24:11 +08:00
```bash
Add color to README Change installation instructions to use shell colors
2013-09-19 23:14:57 +08:00
$ brew cask install google-chrome
Update README.md
2016-01-11 19:37:41 +08:00
==> Downloading https://dl.google.com/chrome/mac/stable/GGRO/googlechrome.dmg
README.md: correct considering we now move (#21566)
2016-06-01 03:46:07 +08:00
==> Moving App 'Google Chrome.app' to '/Applications/Google Chrome.app'
Change default Caskroom path (#21857) * core: change default Caskroom location to be inside brew --repository * docs: change default Caskroom location to be inside brew --repository
2016-06-12 17:09:03 +08:00
🍺 google-chrome staged at '/usr/local/Caskroom/google-chrome/latest' (3 files, 288K)
Add color to README Change installation instructions to use shell colors
2013-09-19 23:14:57 +08:00
```
README.md: general structure fixes
2015-09-16 06:24:11 +08:00
Fix documentation nits Mostly this is spelling, capitalization, and whitespace. One substantive change is updating the list of fields given in FAQ.md to match CONTRIBUTING.md. Also incorporates suggestions from @NanoXD, removing an old paragraph from FAQ.md re: nested containers.
2013-12-08 02:16:58 +08:00
And there we have it. Google Chrome installed with a few quick commands: no clicking, no dragging, no dropping.
README.md: general structure fixes
2015-09-16 06:24:11 +08:00
```bash
[WIP] Change artifact behavior to moving instead of symlinking (#13966) * Change app artifact to move instead of link First step towards change in installation behavior mentioned in [13201] * Fix handling of binaries linked from inside of app bundles Also adds `appdir` method for interpolation in stanzas * Change appdir to root Applications directory * Update 2-app tests * Refactor: add options, ivars to `Installer`, `Download` In preparation for upcoming changes, this commit cleans up some code. The commit includes: - In order to reduce unnecessary object passing, make both the `force` and `skip_cask_deps` option into instance variables of the `Installer` class - Introduce options hashes to initializers of both the `Installer` and `Download` class - When the `install --force` command enters the fetch phase, make it explicit in the code that fetching is never enforced in that case. - Update tests * Force overwrite artifacts on `--force` reinstall This commit changes the behavior of a `Moved` artifact such that if the target already exists, `brew cask install --force` will remove the existing target before moving the staged artifact. In that case, the warning message will say *overwriting* instead of *not moving*. The behavior of plain `brew cask install` remains unchanged; the same goes for the warning message for that case. * Change remaining artifacts to move instead of symlink * Update casks to use appdir in binary paths * Forcibly overwrite artifacts, modifying flags and using `sudo` if needed - This commit implements [the proposed behavior for `install --force`](https://github.com/caskroom/homebrew-cask/pull/13966#issuecomment-220830387) when a target already exists and has either permission problems or is not owned by the user. - The changes apply only when the `force` option is given. - Reused the existing safeguard from the `.pkg` artifact to prevent deleting important directories by bug or mistake - The two existing blacklists `SYSTEM_DIRS` and `UNDELETABLE_DIRS` have been consolidated into the `Hbc::MacOS` module. - `UNDELETABLE_DIRS` now also contains all the entries from `SYSTEM_DIRS` which was a to-do anyway. - The two blacklists are now also frozen for good measure. - The utility method `permissions_rmtree` was moved to `Hbc::Utils`. - The `tried_permissions` part in `Utils` now falls back correctly when there are also ownership issues at the same time. - Introduced a separate `current_user` method for mocking. - Added an optional feature to `FakeSystemCommand` so it can now act as a proxy to `SystemCommand`. - Added tests for various `permissions_rmtree` cases.
2016-06-01 03:23:21 +08:00
$ open /Applications/"Google Chrome.app"
Add color to README Change installation instructions to use shell colors
2013-09-19 23:14:57 +08:00
```
README.md: general structure fixes
2015-09-16 06:24:11 +08:00
Update README.md
2016-01-11 21:56:20 +08:00
## Learn More
add explanation from #38 into readme thanks to @muescha for the good suggestion
2012-10-11 02:55:24 +08:00
Update README.md
2016-02-09 10:12:35 +08:00
* Find basic documentation on using Homebrew-Cask in [USAGE.md](USAGE.md)
README.md: general structure fixes
2015-09-16 06:24:11 +08:00
* Want to contribute a Cask? Awesome! See [CONTRIBUTING.md](CONTRIBUTING.md)
Fix hacking.md link
2016-01-23 13:14:24 +08:00
* Want to hack on our code? Also awesome! See [hacking.md](doc/development/hacking.md)
Delete FAQ.md
2016-01-15 09:57:32 +08:00
* More project-related details and discussion are available in the [documentation](doc)
and info about new IRC channel to README
2013-07-09 22:30:07 +08:00
readme: revamped questions and reporting bugs
2016-06-19 23:41:05 +08:00
## Reporting bugs
and info about new IRC channel to README
2013-07-09 22:30:07 +08:00
Be more accurate in pre bug reporting (#22492)
2016-06-30 10:28:34 +08:00
Like most pieces of software, Homebrew-Cask has bugs — and we are busy fixing them! If you find a new bug tell us about it, but before you do make sure the problem isn’t simply an outdated setup on your side, by following [this guide](doc/reporting_bugs/pre_bug_report.md).
and info about new IRC channel to README
2013-07-09 22:30:07 +08:00
readme: revamped questions and reporting bugs
2016-06-19 23:41:05 +08:00
If your issue persists, follow these instructions to the appropriate course of action:
Add BSD 2 Clause License
2013-09-23 02:37:18 +08:00
readme: revamped questions and reporting bugs
2016-06-19 23:41:05 +08:00
* [A cask fails to install](doc/reporting_bugs/a_cask_fails_to_install.md)
* [My problem isn’t listed][bug_report_template]
doc: remind to upgrade before filing bug report
2014-02-21 21:58:19 +08:00
readme: revamped questions and reporting bugs
2016-06-19 23:41:05 +08:00
## Requests
Add common troubleshooting advice to README We suggest these steps nearly every time someone has a problem, so we should probably display them more prominently in the README.
2016-01-04 17:59:19 +08:00
readme: revamped questions and reporting bugs
2016-06-19 23:41:05 +08:00
* Start an issue on GitHub following one of these templates:
* [Feature request][feature_request_template]
* [Cask request][cask_request_template]
Add common troubleshooting advice to README We suggest these steps nearly every time someone has a problem, so we should probably display them more prominently in the README.
2016-01-04 17:59:19 +08:00
readme: revamped questions and reporting bugs
2016-06-19 23:41:05 +08:00
## Questions? Wanna chat?
Add common troubleshooting advice to README We suggest these steps nearly every time someone has a problem, so we should probably display them more prominently in the README.
2016-01-04 17:59:19 +08:00
readme: revamped questions and reporting bugs
2016-06-19 23:41:05 +08:00
We’re really rather friendly! Here are the best places to talk about the project:
README: December update
2015-12-10 22:47:04 +08:00
readme: revamped questions and reporting bugs
2016-06-19 23:41:05 +08:00
* If none of the templates above is appropriate, [open an issue](https://github.com/caskroom/homebrew-cask/issues/new).
* Join us (and [caskbot](https://github.com/passcod/caskbot)) on IRC at `#homebrew-cask` on Freenode
* Join us on [Gitter](https://gitter.im/caskroom/homebrew-cask)
Additional instructions for reporting bugs
2015-01-11 01:36:08 +08:00
Update README.md
2016-01-11 19:37:41 +08:00
## License
Make links in README relative instead of absolute Fixes #2347 based on recommendations in https://help.github.com/articles/relative-links-in-readmes.
2014-01-07 16:08:08 +08:00
Code is under the [BSD 2 Clause (NetBSD) license](LICENSE)
Add issue templates Add issue template links to README Remove accidental line in feature request template Reorder template links
2015-12-11 02:06:08 +08:00
[bug_report_template]: https://github.com/caskroom/homebrew-cask/issues/new?title=Bug%20report%3A&body=%28Remember%20to%20run%20%60brew%20update%3B%20brew%20cleanup%3B%20brew%20cask%20cleanup%60%20before%20reporting%20your%20issue.%20It%20usually%20fixes%20things%21%29%0A%0A%23%23%23%20Description%20of%20issue%0A%0A%0A%0A%23%23%23%20Output%20of%20%60brew%20cask%20%3Ccommand%3E%20--verbose%60%0A%0A%60%60%60%0A%28paste%20output%20here%29%0A%60%60%60%0A%0A%23%23%23%20Output%20of%20%60brew%20doctor%60%0A%0A%60%60%60%0A%28paste%20output%20here%29%0A%60%60%60%0A%0A%23%23%23%20Output%20of%20%60brew%20cask%20doctor%60%0A%0A%60%60%60%0A%28paste%20output%20here%29%0A%60%60%60%0A
Double-space lines in cask_request.md for consistency
2015-12-11 06:23:21 +08:00
[cask_request_template]: https://github.com/caskroom/homebrew-cask/issues/new?title=Cask%20request%3A&body=%23%23%23%20Cask%20details%0A%0A%28Please%20fill%20out%20as%20much%20as%20possible%29%0A%0A%2A%2AName%2A%2A%20-%0A%0A%2A%2AHomepage%2A%2A%20-%0A%0A%2A%2ALicense%2A%2A%20-%0A%0A%2A%2ADownload%20URL%2A%2A%20-%0A%0A%2A%2ADescription%2A%2A%20-%0A
Add issue templates Add issue template links to README Remove accidental line in feature request template Reorder template links
2015-12-11 02:06:08 +08:00
[feature_request_template]: https://github.com/caskroom/homebrew-cask/issues/new?title=Feature%20request%3A&body=%23%23%23%20Description%20of%20feature%2Fenhancement%0A%0A%0A%0A%23%23%23%20Justification%0A%0A%0A%0A%23%23%23%20Example%20use%20case%0A%0A%0A%0A