52 lines
2.0 KiB
Markdown
52 lines
2.0 KiB
Markdown
# <img src="https://d3vv6lp55qjaqc.cloudfront.net/items/1L1w0v431V0d1K410f3Y/keepAChangelog-logo-dark.svg" height=150 alt="Keep a Changelog" />
|
||
|
||
[![version][version-badge]][CHANGELOG] [![license][license-badge]][LICENSE]
|
||
|
||
Don’t let your friends dump git logs into changelogs™
|
||
|
||
This repository generates http://keepachangelog.com/.
|
||
|
||
## Development
|
||
### Dependencies
|
||
|
||
- Ruby ([see version][ruby-version], [rbenv][rbenv] recommended)
|
||
- Bundler (`gem install bundler`)
|
||
|
||
### Installation
|
||
|
||
- `git clone https://github.com/olivierlacan/keep-a-changelog.git`
|
||
- `cd keep-a-changelog`
|
||
- `bundle install`
|
||
- `middleman` starts the local development server at http://localhost:4567
|
||
|
||
### Deployment
|
||
- `rake publish` builds and pushes to the `gh-pages` branch
|
||
|
||
### Translations
|
||
|
||
Create a new directory in [`source/`][source] named after the ISO 639-1 code
|
||
for the language you wish to translate Keep a Changelog to. For example,
|
||
assuming you want to translate to French Canadian:
|
||
- create the `source/fr-CA` directory.
|
||
- duplicate the `source/en-US/index.html.haml` file in `source/fr-CA`.
|
||
- edit `source/fr-CA/index.html.haml` until your translation is ready.
|
||
- commit your changes to your own [fork][fork]
|
||
- submit a [Pull Request][pull-request] with your changes
|
||
|
||
It may take some time to review your submitted Pull Request. Try to involve a
|
||
few native speakers of the language you're translating to in the Pull Request
|
||
comments. They'll help review your translation for simple mistakes and give us
|
||
a better idea of whether your translation is accurate.
|
||
|
||
Thank you for your help improving software one changelog at a time!
|
||
|
||
[CHANGELOG]: ./CHANGELOG.md
|
||
[LICENSE]: ./LICENSE
|
||
[rbenv]: https://github.com/rbenv/rbenv
|
||
[ruby-version]: .ruby-version
|
||
[source]: source/
|
||
[pull-request]: https://help.github.com/articles/creating-a-pull-request/
|
||
[fork]: https://help.github.com/articles/fork-a-repo/
|
||
[version-badge]: https://img.shields.io/badge/version-0.3.0-blue.svg
|
||
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg
|