Commit Graph

63 Commits

Author SHA1 Message Date
Vítor Galvão 5c72f0182d readme.md: further refinements to header 2015-03-23 03:00:36 +01:00
Paul Hinze a6ef391c3f Update README.md
Italicize slogan. Bump badges down.
2015-03-22 10:56:27 -05:00
Paul Hinze f4e887dfed Merge pull request #10046 from bcomnes/patch-1
Demoted "To install, drag this icon" from readme header.
2015-03-22 10:38:07 -05:00
Bret Comnes 49b7f67bd5 Update README.md 2015-03-21 13:50:57 -07:00
Josh Hagins 6290ca1b2f Add coveralls badge to README.md 2015-03-17 22:02:52 -04:00
Vítor Galvão 9d7810fb1a README.md: issues should be searched for before opened. 2015-03-15 15:02:13 +01:00
Bret Comnes 72b3478d22 Removed "To install, drag this icon" from readme.
I always found the wording of the header in the readme confusing.  e.g. Did homebrew cask used be installed by icon dragging?  Do I install cask by dragging? Oh wait, its referring to what cask enables.

Care if we change the header to something more conventional and just include the concept as a pull quote?
2015-03-14 10:32:50 -07:00
Vítor Galvão d0b874099a README.me: ask for commands to be run with verbose, when reporting bugs 2015-01-11 17:45:04 +00:00
Vítor Galvão e367aea100 Merge pull request #8807 from vitorgalvao/lowercasehomebrew
Made homebrew lowercase in readme
2015-01-11 03:50:35 +00:00
Vítor Galvão 690133b271 Made homebrew lowercase in readme 2015-01-11 03:49:24 +00:00
Vítor Galvão 65599c03dc Additional instructions for reporting bugs 2015-01-10 19:08:45 +00:00
Vítor Galvão e8ebb350bf remove quotes around 'external command' 2015-01-09 16:38:35 +00:00
David J. Felix dfccc92971 Update readme badges for consistency 2014-12-16 10:53:13 -05:00
Michael Ford 67cadb7fc6 Remove Bitdeli Badge from README.md
GitHub now has it’s own analytics.
2014-12-14 16:31:19 +08:00
Maximilian Schüßler 9501d56941 Fix broken documentation link 2014-12-06 14:39:04 +01:00
Roland Walker 6736f795f6 uncapitalize several doc files
* `alternate_cask_taps.md`
* `automation.md`
* `hacking.md`
* `releasing.md`
2014-12-02 12:20:13 -05:00
Roland Walker e0c05651af remove DSL-change banner 2014-11-29 20:35:10 -05:00
Roland Walker 36449339fe doc nit; missing prompt character 2014-09-16 09:42:13 -04:00
Roland Walker 58a4c1092d rename delta file and update transition docs
requires #6074 (may show merge conflict)
2014-09-08 20:37:42 -04:00
Roland Walker a38ec50a3b doc: first changes for DSL 1.0
Do not revert this PR after the transition period.  It contains
a README banner which needs to be deleted later, but also a
persistent doc file and an unrelated whitespace nit.
2014-09-08 10:48:39 -04:00
Roland Walker bfd88bc5af Move the Tap Migration banner from README to FAQ
We have not seen an issue filed on this in some time.
2014-07-28 14:33:00 -04:00
Rico Sta. Cruz 8fc4701c81 Readme: update install instructions 2014-07-21 13:52:11 +08:00
Roland Walker 6ff511cd7c recommend `brew cask cleanup` before bug report
A user reported this fixed a problem in #4772.

References: #4857
2014-06-14 08:39:58 -04:00
Roland Walker d37a10ed96 document Tap migration
The change to the main README should be temporary (two weeks?).
2014-05-05 10:30:51 -04:00
Paul Hinze f54eaf7082 update all references to new caskroom org home
global replace of:
  'phinze/homebrew-cask' -> 'caskroom/homebrew-cask'
  'phinze/cask' -> 'caskroom/cask'
  'phinze/homebrew-testcasks' -> 'caskroom/homebrew-testcasks'

and various other specific places that needed updates

<3 the homebrew-cask community!
2014-05-03 10:29:17 -05:00
Roland Walker f5078b03fb demote FAQ.md to doc directory
This doc currently has very little content.  Also fix link
text for other content in the doc directory.
2014-03-01 08:24:24 -05:00
Roland Walker de7a8cdcc9 doc: expand CASK_LANGUAGE_REF, shrink CONTRIBUTING
following up on #3094
- rename `THE_CASK_LANGUAGE.md` to `CASK_LANGUAGE_REFERENCE.md`
- expand `CASK_LANGUAGE_REFERENCE.md` to more fully specify the Cask DSL
- add sections: "Casks Are Ruby Classes" and "The Cask Language Is Declarative"
- import content from `FAQ.md` to `CASK_LANGUAGE_REFERENCE.md`, create multiple sections
  listing all stanzas according to category.
- document which stanzas are permitted multiple times
- add previously undocumented `before_install` and `before_uninstall`
- doc that `Hardware::CPU.is_64_bit?` (and 32-bit) are acceptable in conditionals
- doc that `:target` may contain an absolute path (this works more reliably after #3075)
- doc that `uninstall` is optional in the DSL, but required by the community
- link examples
- standardize mixed language on "stanza" over "field"
- further shrink `CONTRIBUTING.md` by deleting rarely used stanzas
  and referencing `CASK_LANGUAGE_REFERENCE.md`
2014-02-24 15:49:37 -05:00
Roland Walker ce58a0d9c3 Merge pull request #3074 from rolandwalker/doc_bug_report
doc: remind to upgrade before filing bug report
2014-02-21 17:10:29 -05:00
Roland Walker 1ec1eb682e doc: remind to upgrade before filing bug report 2014-02-21 08:58:19 -05:00
Roland Walker b7dcd35dab move HACKING.md and CHANGELOG.md to doc subdir 2014-02-20 19:17:02 -05:00
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