Skip to content

Commit

Permalink
Document release making process
Browse files Browse the repository at this point in the history
Document how to make a release of the project in a contributing file. Also add the contributing file to the Cabal build file.

Closes #10
  • Loading branch information
ExcaliburZero committed Jul 16, 2016
1 parent f89b650 commit 3a9bbf7
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,25 @@
# Contributing

## Releases
Whenever a new release of the program is made, there are a few things that should be updated:

* `CHANGELOG.md` - Information the changes in the new release should be added.
* `pixelated-avatar-generator.cabal` - The version should be updated.

Once those changes have been made, a release for the application should be made on GitHub, and the following files should be included:

* `doc.zip` - A zip archive of the generated haddock documentation.
* `pixelated-avatar-generator` - An executable Linux binary of the program.

The Haddock documentation and Linux binary can be generated by running the following commands:

```
stack build
stack haddock
```

Once the release on GitHub has been made, the package should then be released on Hackage. This can be done by generating the package with the following command, and uploading it to Hackage.

```
stack sdist
```
1 change: 1 addition & 0 deletions pixelated-avatar-generator.cabal
Expand Up @@ -20,6 +20,7 @@ category: Image, Graphics
build-type: Simple
extra-source-files: README.md
CHANGELOG.md
CONTRIBUTING.md
example_image.png
test/Graphics/Avatars/helloAvatar.png
cabal-version: >=1.10
Expand Down

0 comments on commit 3a9bbf7

Please sign in to comment.