Browse Source

Update CONTRIBUTING to reflect newer style guides

Specify that the SHA-1 checksum shall be used and that the name of the
linked app must be specified via `link`

closes #293
pangratz 12 years ago
committed by phinze
parent
commit
5b22534368
  1. 11
      CONTRIBUTING.md
  2. 1
      test/support/Casks/basic-cask.rb

11
CONTRIBUTING.md

@ -67,7 +67,8 @@ end
only `.app` files are supported) only `.app` files are supported)
* Application homepage * Application homepage
* Application version * Application version
* Checksum of the file * SHA-1 Checksum of the file
* name of the linked `.app` file, via `link :app, 'MyApp.app'`
In order to find out the checksum for the file, you need to download the file In order to find out the checksum for the file, you need to download the file
and then: and then:
@ -81,12 +82,8 @@ end
Some developers (like Mozilla) and hosts (like Sourceforge) provide checksums, Some developers (like Mozilla) and hosts (like Sourceforge) provide checksums,
so you can use those directly, without needing to download the file separately. so you can use those directly, without needing to download the file separately.
In addition to `sha1` you can provide the checksum with `md5`, `sha256`, or `sha512` If the application does not have versioned downloads, you can provide the option
in the same manner. Use commands `md5 my-app.dmg` or `shasum -a 256 my-app.dmg`
to obtain these checksums.
If the application does not have versioned downloads, you can provide option
`no_checksum`, which takes no arguments. `no_checksum`, which takes no arguments.
This is all you need to do to write a Cask! This is all you need to do to write a Cask!

1
test/support/Casks/basic-cask.rb

@ -3,4 +3,5 @@ class BasicCask < TestCask
homepage 'http://example.com/' homepage 'http://example.com/'
version '1.2.3' version '1.2.3'
sha1 '0123456789012345678901234567890123456789' sha1 '0123456789012345678901234567890123456789'
link :app, 'TestCask.app'
end end

Loading…
Cancel
Save