Skip to content

Commit a19464b

Browse files
committed
Add a copy/pastable release text. Fixes #218
1 parent 1be950f commit a19464b

1 file changed

Lines changed: 13 additions & 14 deletions

File tree

RELEASE.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ that describes the version number, and gives it a date.
3333

3434
The "next release" section should contain only "Your contribution here".
3535

36+
_Note: It's useful to add the version to the commit message when you bump it: e.g. `Bump version to v2.3.4`.
37+
3638
## Generate the Binaries
3739

3840
```plain
@@ -49,28 +51,25 @@ VERSION matches the value of the `Version` constant.
4951

5052
Upload all the binaries from `release/*`.
5153

52-
## Update Homebrew
54+
Past the release text and describe the new changes:
5355

54-
This is helpful for the (many) Mac OS X users.
56+
```
57+
### Exercism Command-Line Interface (CLI)
5558
56-
Fork and clone [homebrew/homebrew-binary](https://github.com/homebrew/homebrew-binary/fork).
59+
Exercism takes place in two places: the discussions happen on the website, and you work on exercises locally. The CLI bridges the gap, allowing you to fetch exercises and submit solutions to the site.
5760
58-
Add the upstream repository:
61+
This is a stand-alone binary, which means that you don't need to install any particular language or environment in order to use it.
5962
60-
```plain
61-
$ git remote add upstream git@github.com:Homebrew/homebrew-binary.git
62-
```
63+
To install, download the archive that matches your operating system and architecture, unpack the archive, and put the binary somewhere on your path.
6364
64-
If you already had this cloned, ensure that you are entirely up-to-date with the upstream master:
65+
You will need to configure the CLI with your [Exercism API Key](http://exercism.io/account/key) before submitting.
6566
66-
```plain
67-
$ git fetch upstream && git checkout master && git reset upstream/master && git push -f origin master
68-
```
67+
For more detailed instructions, see the [CLI page on Exercism](http://exercism.io/cli).
6968
70-
Check out a feature branch, where X.Y.Z is the actual version number.
69+
#### Recent Changes
7170
72-
```plain
73-
$ git checkout -b exercism-vX.Y.Z
71+
* ABC...
72+
* XYZ...
7473
```
7574

7675
Calculate the `SHA1` checksum for the two mac builds:

0 commit comments

Comments
 (0)