Skip to content

Commit

Permalink
Updated README with new development policies
Browse files Browse the repository at this point in the history
  • Loading branch information
JavierJF committed Sep 28, 2016
1 parent d31fd8c commit d734c6b
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
This package is looking for a new maintainer
============================================
`bindings-GLFW` and `GLFW-b` are looking for a new maintainer. Please comment in [this issue](https://github.com/bsl/bindings-GLFW/issues/39) if you would like to take maintainership.

GLFW-b
======
[![Hackage](https://img.shields.io/hackage/v/GLFW-b.svg)](http://hackage.haskell.org/package/GLFW-b)

## Description

[Haskell][1] bindings to [GLFW][2], an Open Source, multi-platform library for
creating windows with OpenGL contexts and managing input and events.

Expand All @@ -14,15 +12,31 @@ binds to GLFW 3.1, [released 2015-01-18][4].

For a demonstration of GLFW-b, see [GLFW-b-demo][5].

When running GLFW-b in GHCI, don't forget to
When running GLFW-b in GHCI, don't forget to

:set -fno-ghci-sandbox

since GHCI can (and might) run each line of your code in a fresh unbounded
since GHCI can (and might) run each line of your code in a fresh unbounded
thread.

## For devs

This package uses git-flow as development model, in short that means that:

1. New features should be added to "develop" branch.
2. "master" branch is reserved for stable releases.
3. Patches for bugs related with previous releases should always be done in
"hotfixes" branch.

Until we have a defined road-map we are going to leave out "release
"branches" and "feature branches". For more information about this development
model please refer to [this site.][6]

Thanks you, and happy coding.

[1]: http://www.haskell.org/
[2]: http://www.glfw.org/
[3]: https://github.com/bsl/bindings-GLFW
[4]: http://www.glfw.org/Version-3.1-released.html
[5]: https://github.com/bsl/GLFW-b-demo
[6]: http://nvie.com/posts/a-successful-git-branching-model/

0 comments on commit d734c6b

Please sign in to comment.