Commit graph

16 commits

Author SHA1 Message Date
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
Paul Hinze
1f5cc4e1e8 Merge pull request #2719 from lgarron/sha256
Change the template hash function to SHA-256.
2014-02-08 12:20:33 -06:00
Lucas Garron
913f3e6f76 Change default hash to SHA-256. 2014-02-05 18:16:18 -08:00
Roland Walker
9445b05c4d tiny nits on new Screen Saver artifact
whitespace, filenames, orthography to be consistent with
other artifacts. No functional change.
2014-02-03 11:21:09 -05:00
Roland Walker
872132f7c8 screensaver spelled screen_saver in DSL and opts 2014-01-29 11:27:44 -05:00
Jonathan Dahan
ca61dfdd81 Add support for screensaver artifact 2014-01-28 10:17:50 -05:00
Roland Walker
9d439510d3 add dependencies for Homebrew Formulae
new DSL key `depends_on_formula`
2014-01-22 16:22:07 -05:00
Roland Walker
329c48298a caveats first-class in DSL, gets own mini-DSL
Make caveats a first-class member of the Cask DSL.  It no longer has to
be specified with "def caveats", but can be given as "caveats do ... end"
as with after_install blocks.

In addition, create a mini-DSL which can be used within caveats blocks,
providing standard messages when manual installers must be used,
reboot-required, etc.

Add alternate form: caveats can also accept a compile-time string for
simple cases.

This is 99% compatible with old Casks, as it still works by defining
a caveats method.  However, all Casks containing caveats are cleaned
up and adapted according to the new DSL.

Full docs in CONTRIBUTING.md.
2014-01-20 11:54:46 -05:00
Lincoln Lee
cc14ebdb55 Implement input_method artifact 2014-01-19 00:40:56 +08: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
Stratos Moros
7136269198 implement binary artifact 2014-01-05 22:55:18 +02:00
Roland Walker
9ed8407265 document caveats, after_install, after_uninstall
in FAQ.md and CONTRIBUTING.md.  Also divide fields in CONTRIBUTING.md
into two sections: frequently-used and infrequently-used .
2013-12-09 19:56:25 -05: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
8fec1b583c Update FAQ
- Add install/uninstall fields
- Change capabilities brief
2013-09-19 08:25:46 -07:00
Michael Ford
9a53074a93 Update FAQ.md to include all 5 cask fields 2013-07-29 02:16:55 +08:00
phinze
354dfc3a75 split docs into README, USAGE, FAQ
moving towards more complete, centralized, maintainable documentation
2013-04-28 14:20:03 -05:00