mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 19:25:28 -05:00
readme (and new file, HOWTO.md)
This commit is contained in:
parent
d2abd46d13
commit
46ebb559fe
2 changed files with 25 additions and 0 deletions
11
HOWTO.md
Normal file
11
HOWTO.md
Normal file
|
|
@ -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
|
||||||
|
|
||||||
14
README.md
14
README.md
|
|
@ -129,6 +129,9 @@ The prefered way to install is through [opam](http://opam.ocaml.org/).
|
||||||
|
|
||||||
### From Sources
|
### From Sources
|
||||||
|
|
||||||
|
On the branch `master` you will need `oasis` to build the library. On the
|
||||||
|
branch `stable` it is not necessary.
|
||||||
|
|
||||||
$ make
|
$ make
|
||||||
|
|
||||||
To build and run tests (requires `oUnit` and `qtest`):
|
To build and run tests (requires `oUnit` and `qtest`):
|
||||||
|
|
@ -147,3 +150,14 @@ To build the small benchmarking suite (requires `benchmark`):
|
||||||
$ opam install benchmark
|
$ opam install benchmark
|
||||||
$ make bench
|
$ make bench
|
||||||
$ ./benchs.native
|
$ ./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`)
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue