From 46ebb559fea346e30b1580630e439f3ba5a548e1 Mon Sep 17 00:00:00 2001
From: Simon Cruanes <simon.cruanes.2007@m4x.org>
Date: Fri, 8 Aug 2014 19:33:08 +0200
Subject: [PATCH] readme (and new file, HOWTO.md)

---
 HOWTO.md  | 11 +++++++++++
 README.md | 14 ++++++++++++++
 2 files changed, 25 insertions(+)
 create mode 100644 HOWTO.md

diff --git a/HOWTO.md b/HOWTO.md
new file mode 100644
index 00000000..116ca78d
--- /dev/null
+++ b/HOWTO.md
@@ -0,0 +1,11 @@
+
+## Make a release
+
+1. `make test-all`
+2. merge into `stable` (from now on, proceed on branch `stable`)
+3. update version in `_oasis`
+4. `make update_next_tag` (to update `@since` comments)
+5. update `CHANGELOG.md` (see its end to find the right git command)
+6. commit, tag, and push both to github
+7. new opam package
+
diff --git a/README.md b/README.md
index c556bc39..9e9fa580 100644
--- a/README.md
+++ b/README.md
@@ -129,6 +129,9 @@ The prefered way to install is through [opam](http://opam.ocaml.org/).
 
 ### From Sources
 
+On the branch `master` you will need `oasis` to build the library. On the
+branch `stable` it is not necessary.
+
     $ make
 
 To build and run tests (requires `oUnit` and `qtest`):
@@ -147,3 +150,14 @@ To build the small benchmarking suite (requires `benchmark`):
     $ opam install benchmark
     $ make bench
     $ ./benchs.native
+
+## Contributing
+
+PRs on github are welcome (patches by email too, if you prefer so).
+
+A few guidelines:
+
+- no dependencies between basic modules (even just for signatures)
+- add `@since` tags for new functions
+- add tests if possible (using `qtest`)
+