Commit graph

123 commits

Author SHA1 Message Date
Radek Simko
cec19153ff Typos and facts about how to use 2FA fixed 2014-07-13 23:26:34 +01:00
Alex Barclay
54da9567bf Add push cask info for github 2 factor auth 2014-07-09 16:21:40 -05:00
ndr
797344bc18 Docs: admit unstable releases in main repo 2014-07-03 22:27:50 +02:00
Roland Walker
3cb729095d suggested (not enforced) order for Cask stanzas
References: #4914
2014-06-16 13:32:08 -04:00
Vítor Galvão
9e96d5afda Document policy on trial versions
Pinging @rolandwalker to sign off on the wording.
2014-06-09 00:30:45 +01:00
Roland Walker
979ddc7c54 Merge pull request #4738 from rolandwalker/doc_https_tweaks
doc: separate the HTTPS statement under one heading
2014-06-07 13:38:19 -04:00
Radek Simko
d2efc5e520 Note about Dropbox URLs added 2014-06-07 17:02:37 +01:00
Roland Walker
770643a5f7 Separate the HTTPS statement under one heading
also update examples to use HTTPS
2014-06-06 22:15:24 -04:00
Vítor Galvão
112964ca7f changed mentions of 'brew --prefix' to 'brew --repository' 2014-05-09 01:02:48 +01:00
Roland Walker
c436ddc5fd transition docs/tests/messages to sha256 :no_check
`sha256 :no_check` has been supported syntax for a couple of months,
and now is being transitioned to the preferred syntax, replacing
the `no_checksum` stanza (which will still be supported, but
deprecated)
2014-05-08 08:42:44 -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
Jean-Christophe GAY
34e62f08bf Use new taps directory structure in documentation
Replace /Library/Taps/phinze-cask/ by /Library/Taps/phinze/homebrew-cask/
2014-04-27 09:43:53 +02:00
Roland Walker
99ecfc3651 devscript: add cask_namer
This script implements naming rules for App-based Casks
as currently documented.  After some real-world testing, this
logic should be merged into `brew cask create`.  This commit adds
`doc/CASK_NAMING_REFERENCE.md`, and reduces `CONTRIBUTING.md` by
422 words.
2014-03-07 13:43:40 -05:00
Roland Walker
0c576a6012 doc: prepend vendor names to disambiguate
note as well that Casks which differ only by placement
of hyphens are somewhat ambiguous and to be avoided.
2014-03-04 08:37:25 -05:00
Roland Walker
83b8431b1d Merge pull request #3285 from rolandwalker/doc_cask_name_drop_version
doc: drop version numbers from end of Cask names
2014-03-01 06:48:39 -05:00
Roland Walker
c0f434c76d doc: drop version numbers from end of Cask names 2014-02-28 11:41:33 -05:00
Roland Walker
2375c10504 doc: tweaks to CONTRIBUTING.md
- subheads so we can link directly to CONTRIBUTING.md#cask-stanzas
- clarification on naming `pkg` Casks
- fix repetitive language
2014-02-28 09:14:58 -05:00
Roland Walker
30dab022e7 Drop generic terms from ends of Canonical name 2014-02-27 08:33:23 -05:00
Roland Walker
dd88c5efcb Merge pull request #3175 from rolandwalker/doc_cask_name_drop_characters
drop non-alpnanumeric chars from Canonical Name
2014-02-27 08:05:26 -05:00
Roland Walker
b5f8fd0ca3 doc that vendor/upstream URLs are preferred
(unfortunately adding words to CONTRIBUTING.md again)
2014-02-26 06:42:56 -05:00
Roland Walker
8d8493b26e drop non-alpnanumeric chars from Canonical Name
following up on #2659, further steps toward an algorithmic
derivation of Canonical Name from App Name.

Also add two rules about hyphens which are implied and already
followed by every Cask.
2014-02-25 08:37:31 -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
9dad8600a3 shrink CONTRIBUTING.md to 1/4 its current size
Rationale:
- lengthy CONTRIBUTING.md may itself discourage new Cask authors
- it is doubtful that everyone reads to the end, where there
  are important notes about squashing.

CONTRIBUTING.md reduced from 7947 words to 1927 words.

This was accomplished principally by spinning out "details" sections
into a new reference file `doc/THE_CASK_LANGUAGE.md`, but also by
ruthless re-organization, removal of duplication, and trimming of
phrases. Content remains 99% identical, though a few typos were
caught along the way, and a table of contents was added.
2014-02-22 14:51:55 -05:00
Paul Hinze
73d0273b98 Merge pull request #3067 from rolandwalker/organize_docs
move HACKING.md and CHANGELOG.md to doc subdir
2014-02-21 15:35:58 -06:00
Caleb Xu
beab539ca3 Added clause about cases with no available stable versions 2014-02-20 21:42:29 -05:00
Roland Walker
b7dcd35dab move HACKING.md and CHANGELOG.md to doc subdir 2014-02-20 19:17:02 -05:00
Caleb Xu
6c6f07c8bf Added ## Finding a Home For Your Cask
Explains the alternate `caskroom` repositories and what belongs there.
2014-02-19 16:53:05 -05:00
Roland Walker
763bbfbc2e Merge pull request #2659 from rolandwalker/cask_naming_1
doc: Canonical name == App bundle name
2014-02-19 09:52:46 -05:00
Roland Walker
fbcbcd21be Merge pull request #2761 from rolandwalker/private_eye_followups
sleep during uninstall, allow `:must_succeed`
2014-02-15 07:44:33 -05:00
Roland Walker
b023953def document Subversion URLs
lightly re-org the URL Details section
2014-02-14 21:26:53 -05:00
Roland Walker
45ed67c64f add :allow_untrusted modifier on install 2014-02-11 14:40:16 -05:00
Roland Walker
273a9d95b3 devscript: add command list_payload_in_pkg 2014-02-10 10:47:12 -05:00
Roland Walker
de78b0f359 sleep during uninstall, allow :must_succeed
on script directives. followups from #1802. amend private-eye Cask.
2014-02-08 16:15:15 -05:00
Roland Walker
4802067e30 Merge pull request #2810 from rolandwalker/doc_devscripts
Document all developer scripts
2014-02-08 16:11:06 -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
Roland Walker
124f8d44a3 Document all developer scripts
Significantly rewrite "Uninstall Details" in `CONTRIBUTING.md`
2014-02-08 08:03:09 -05:00
Roland Walker
320f8a46d8 Merge pull request #2637 from rolandwalker/version_caveats
add os_version_only to caveats DSL
2014-02-06 08:25:40 -05:00
Roland Walker
34f38caf3e add os_version_only to caveats DSL 2014-02-06 08:25:17 -05:00
Lucas Garron
913f3e6f76 Change default hash to SHA-256. 2014-02-05 18:16:18 -08:00
Roland Walker
bf7b16c0fd Merge pull request #2554 from rolandwalker/caveats_on_dashboard_widgets
Loud caveats against installing Dashboard Widgets
2014-02-04 15:44:53 -08:00
Roland Walker
ba218993a1 Loud caveats against installing Dashboard Widgets
And doc note, pending a fix of the underlying issue.
2014-02-03 11:28:44 -05: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
ffe9d025a0 Merge pull request #2681 from rolandwalker/doc_uninstall_sections
doc: create specific uninstall sections
2014-01-30 16:25:43 -08:00
Roland Walker
872132f7c8 screensaver spelled screen_saver in DSL and opts 2014-01-29 11:27:44 -05:00
Fernando Paredes
8f177a81ac Merge pull request #2680 from rolandwalker/doc_xfer_contributing_fonts
move font-specific docs to the font repo
2014-01-28 08:58:08 -08:00
Roland Walker
a7bdac580b doc: create specific uninstall sections
move recipes from "Good Things to Know"
2014-01-28 11:32:38 -05:00
Roland Walker
d50f4d5def move font-specific docs to the font repo 2014-01-28 11:07:51 -05:00
Jonathan Dahan
ca61dfdd81 Add support for screensaver artifact 2014-01-28 10:17:50 -05:00
Paul Hinze
ae2d5822e1 Merge pull request #2592 from rolandwalker/arch_caveats
add arch_only to caveats mini-DSL
2014-01-28 06:29:16 -08:00
Paul Hinze
3179a55e71 Merge pull request #2391 from rolandwalker/uninstall_script_order
Defer :script uninstall, add :early_script
2014-01-28 06:20:43 -08:00