Commit Graph

33 Commits

Author SHA1 Message Date
Roland Walker 46a0e53e27 add Reporting Bugs section to README 2014-01-27 10:45:24 -05:00
Roland Walker 9c2c589a7c truly trivial doc followups
- sync the docs to match some recent PRs
- formatting mistakes
- capitalization
- quoting
2014-01-18 11:38:34 -05:00
Roland Walker 8f9fc13cf5 standardize project name: homebrew-cask
- make lower-case and remove backticks for project name
  (backticks kept for commands/filenames/etc)
2014-01-17 20:14:48 -05:00
Geoffrey Oxberry 25ddc729ff 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 09:20:48 -08:00
Seyi Ogunyemi 644c9512fc README: update initial instruction.
Homebrew handles the prefixes automatically.
2013-12-23 12:06:18 +00:00
Roland Walker e6630fb49e 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-07 13:42:16 -05:00
Fernando Paredes 642a7c5f53 Add BSD 2 Clause License 2013-09-22 11:37:18 -07:00
Fernando Paredes 1ccc705a3c Add color to README
Change installation instructions to use shell colors
2013-09-19 08:14:57 -07:00
Fernando Paredes a2264a487e Add Bitdeli badge
Add bitdeli badge to readme.
2013-08-12 14:03:06 -07:00
phinze 18f115c12b and info about new IRC channel to README 2013-07-09 09:30:07 -05:00
phinze b48bf00dc7 Remove coverage status from README
Since it ain't gonna work with ruby 1.8. Maybe someday, maybe someday.
2013-05-02 15:52:11 -05:00
Mathias Bynens c7b897b99b README: Fix typo
`open "~/Applications/Google Chrome.app"` won’t work as intended, since the tilde isn’t expanded in that case.
2013-05-02 22:18:17 +03:00
phinze 9236a74393 lets try coveralls.io 2013-04-28 16:50:54 -05:00
phinze 354dfc3a75 split docs into README, USAGE, FAQ
moving towards more complete, centralized, maintainable documentation
2013-04-28 14:20:03 -05:00
Paul Gross 661cce07f2 Update README.md with new location of caskroom. 2013-04-27 22:19:33 -07:00
Vítor Galvão 85ea4b5909 Clarified that what goes to /Applications are links 2013-04-12 15:19:31 +01:00
Vítor Galvão b4f2933f9b hopefully resolved confusion with 'a-cask' 2013-04-12 11:30:41 +01:00
phinze 18f281b385 add code climate for the hell of it 2013-04-05 02:35:15 -06:00
phinze 81ebce073a correct branch on travis badge 2013-04-05 02:12:40 -06:00
phinze 1797ce9400 travis badge woo 2013-04-05 02:10:59 -06:00
phinze 47544e46b6 Reflect the Cellar -> Caskroom change in README 2013-02-18 08:53:38 -06:00
Félix Saparelli 14bd960b3d Add link to ‘Contributing’ wiki page
Re: @mkouhia's #127.
2013-01-07 09:41:00 +13:00
Zach Hobbs c42e8a737b Add tip about mac file chooser
By default, the mac file chooser won't list folders like /usr/,
add tip to readme about Cmd-Shift-G workaround.

Signed-off-by: Félix Saparelli <me@passcod.net>
2013-01-07 09:39:19 +13:00
Félix Saparelli 9c74809989 Fix opts syntax (see #123) 2013-01-03 15:18:05 +13:00
Félix Saparelli 5ad6796bcd Add options to the cli
Options can be passed on the command-line and/or using
the HOMEBREW_CASK_OPTS environment variable (which has
lowest priority). There is a single --appdir=PATH option
right now, but this commit enables future awesomeness!

Other minor changes:

* `brew cask help` now returns the same thing as `brew cask`
  instead of saying there was “no such command as help”.

* The HEREDOC block now uses Homebrew's #undent instead of the
  customed-rolled #gsub version. Cleaner and more flexible.

* `Cask.set_appdir` has been renamed to `Cask.appdir=`. This
  is more Rubyish, and of little consequence (the only place
  it was previously used was in the tests).
2012-12-19 00:54:49 +13:00
phinze 50bbd4e195 adding note about homebrew version requirement
did the research to figure out in which HOMEBREW_VERSION the wild Tap
linking problem that we ran into in #37 was fixed.

hopefully this will prevent other folks from running into it.
2012-10-20 13:12:33 -05:00
phinze 0ec6e18fde readme tweak 2012-10-12 19:11:15 -05:00
phinze 18f947fa90 add explanation from #38 into readme
thanks to @muescha for the good suggestion
2012-10-10 13:57:31 -05:00
Félix Saparelli 96b192f26b Update README w/ info about taps 2012-09-24 16:47:45 +12:00
phinze df45d87408 readme cleanup and updates 2012-08-25 22:01:34 -05:00
phinze b242a97f53 update README and add a version 2012-08-25 21:32:06 -05:00
phinze 383dbe870e Get the readme in line with our current status 2012-03-10 02:12:09 -06:00
phinze 5a0d1d5556 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-09 22:43:50 -06:00