search

taborlab / Iris

The Light Program Interface
BSD 3-Clause "New" or "Revised" License
12 stars 2 forks source link

Add changelog #279

Closed SynbioLucas closed 8 years ago

SynbioLucas commented 8 years ago

Add changelog for users to track updates.

SynbioLucas commented 8 years ago

@BrianLandry @felixekn

I've added this after discussion with @BrianLandry regarding the best way to inform users on recent updates, especially relevant when we add something that isn't necessarily backwards compatible.

It follows a fairly simple convention for changelogs documented here. As y'all make changes to master in the future, please try to update your changes under the appropriate subheadings (e.g. Added, Fixed, Changed, etc.) of the Unreleased version heading.

New versions will be incremented/released whenever master is pulled into gh-pages. This will require running pandoc on the markdown file to create the HTML file, so I should probably do this (though it's all documented in the file /documentation/pandoc_configuration.txt). I'll probably be the one promoting things from master to gh-pages anyway, since we'll be minifying the code then.

Just lemme know if y'all have comments/suggestions.