Commit Graph

160 Commits

Author SHA1 Message Date
Vítor Galvão 5ec20495a7 contributing.md: clarifications to sourceforge links
- SourceForge is the one picking the best mirror with latest download, not the maintainers.
- Latest downloads should only be used it the app us mac-exclusive.
2015-01-22 16:48:43 +00:00
ndr d5722ee079 Merge pull request #8751 from vitorgalvao/remove-widget-support
Remove support for widgets
2015-01-11 12:29:00 +00:00
ndr 9bdd0b27fc Merge pull request #8748 from vitorgalvao/registration-wall
Rules (and cask removals) regarding registration walls and vendorless downloads)
2015-01-10 13:55:24 +00:00
Vítor Galvão af9dfde010 link to reporting-bugs in readme, instead of repeating it 2015-01-09 16:45:57 +00:00
Vítor Galvão 529bd801e4 Removed support for widgets
Closes #2206.
2015-01-08 19:51:15 +00:00
Vítor Galvão f07e6944e2 contributing.md: rules regarding vendorless or behind-registration-walls downloads 2015-01-08 19:20:43 +00:00
Vítor Galvão 858cec08f7 Merge pull request #8222 from nZac/contributing-issue-message
Added reporting bugs section to contributing guide
2015-01-03 18:33:08 +00:00
Roland Walker 61bb650d7f fix broken doc links 2015-01-02 09:55:39 -05:00
Nick Zaccardi d27a7f9eb0 Added reporting bugs section. 2014-12-18 10:23:24 -06:00
Roland Walker 1413bea1c0 `sha256 :no_check` overrides `version <string>`
This behavior was traditionally present, and is now recovered
by removing the audit test added in #4743.  The doc is clarified
but did not require major change.

closes: #6356
refs: #8179
2014-12-17 08:21:51 -05:00
Roland Walker d96c17b9db enable `license :freemium` 2014-12-11 09:42:24 -05:00
Roland Walker be1bf6dfac document `name` stanza
and undocument obsolete `tags :name`
2014-12-09 18:53:34 -05:00
Roland Walker ba911b9165 Merge pull request #7741 from rolandwalker/reduce_doc_shouting
uncapitalize several doc files
2014-12-03 08:46:39 -05:00
Vítor Galvão cf4c4bc2a6 contributing.md: clarifications regarding looser sourceforge.jp rules 2014-12-02 17:56:28 +00: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 a335d3b06d unify and recast "Cask name" & "title" as "token"
* "Canonical App Name" becomes "Simplified App Name"
* devscript `cask_namer` renamed to `generate_cask_token`
* doc file `CASK_NAMING_REFERENCE.md` renamed to `cask_token_reference.md`
* DSL uses `"#{token}"` for interpolation instead of `"#{title}"`
* documentation text
* backend code (variables, method, class names)
* error message text
* tests
* code comments
* Cask comments
* emphasize `tags :name`
* doc: use "vendor" consistently instead of "developer"
* doc: many man page argument descriptions were incorrect
* incidental clarifications

Many backend variables similar to `cask_name` or `cask` have
been standardized to `cask_token`, `token`, etc, resolving a long-
standing ambiguity in which variables named `cask` might contain
a Cask instance or a string token.

In many places the docs could be shortened from "Cask name" to
simply "token", which is desirable because we use the term "Cask"
in too many contexts.
2014-12-01 11:00:23 -05:00
Roland Walker 04fb60a112 blank before uninstall in CONTRIBUTING 2014-11-22 09:12:35 -05:00
Vítor Galvão 4779b35cc4 added note for sourceforge.jp urls in CONTRIBUTING 2014-11-17 02:38:00 +00:00
Roland Walker 7c9cec2f4e use new header form in docs 2014-11-13 11:30:55 -05:00
Roland Walker 15ff9d884a say "URL" instead of "link" in documentation 2014-10-28 12:12:10 -04:00
Roland Walker 41cf7d96f0 docs and tests for new form `container :nested` 2014-10-09 11:34:37 -04:00
Roland Walker 0320569e87 generalize section on Dropbox URLs
and explain why they should be avoided
2014-10-09 07:50:51 -04:00
Roland Walker 309980bb86 doc re: fosshub and dropbox URLs
* fosshub URLs are blocked (per email correspondence)
  all similar providers cannot be used in Casks.
* shorten dropbox text
2014-10-08 09:26:55 -04:00
Roland Walker f1604e4efb docs and create template for new license stanza
some :closed licenses in the code are left undocumented for
now, and should not be used.
2014-10-01 11:18:13 -04:00
Roland Walker a57ac581a6 doc nits: table order, table format, whitespace
make the order of tables match the order of stanzas in
the examples and `brew cask create` template
2014-09-27 13:35:49 -04:00
Roland Walker 6d82c9770e change docs/tests to use version :latest
Instead of version 'latest' (value as string).  The string
value is still permitted during a transitional period.
2014-09-17 07:22:33 -04:00
Roland Walker edb28f57b1 document new suite stanza
* includes other doc nits
* link to `sketchup.rb` will not work until the Casks are also changed
2014-09-16 11:19:08 -04:00
Roland Walker 5ae6e2f773 doc new `app` stanza and update tests to use it
Replacing `link` for almost all cases.

The `link` stanza can still appear in error messages, because
under the hood, `app` is still implemented as a pure synonym
for the `link` artifact.  That will change automatically when
we factor into separate artifacts.
2014-09-13 13:03:46 -04:00
Roland Walker bc10676818 Merge pull request #6139 from rolandwalker/doc_nit_anchor
doc nits re: caveats.  Broken anchor link.
2014-09-11 20:22:54 -04:00
Vítor Galvão 8491b10186 Merge pull request #6150 from vitorgalvao/change-vagrant-examples
replaced vagrant with unity in examples referencing the pkg
2014-09-11 20:24:26 +01:00
Vítor Galvão be96758d83 Changed Firefox to Firefox.app in CONTRIBUTING, for consistency with other examples. 2014-09-11 20:15:06 +01:00
Vítor Galvão e8ac96693e replaced vagrant with unity in examples referencing the pkg 2014-09-11 20:09:24 +01:00
Trey Harris 46a9b82283 CONTRIBUTING.md: Adding unversioned Cask info
The docs seemed to suggest that if versioned downloads were available,
to prefer them over unversioned ones. Since that's incorrect presently,
I attempted to correct that (see #6126 for more details).
2014-09-11 15:05:07 -04:00
Roland Walker cfd6bd003e doc nits re: caveats. Broken anchor link. 2014-09-11 10:50:27 -04:00
Roland Walker 8bbc5e6635 DSL doc: uninstall now available for all Casks
But required for `pkg`-based Casks.  Also contains some general
cleanup in section "Uninstall Stanza Details", which still needs
work.
2014-09-11 09:26:01 -04:00
Roland Walker ab4f52a781 docs and error messages for new DSL stanza `pkg`
transition from `install` to `pkg`
2014-09-10 10:54:06 -04:00
Martin madsen e4e47b3f5d Fix markdown link in CONTRIBUTING.md
Added a missing closing parentheses.
2014-07-29 14:02:08 +02:00
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