simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-08 12:15:32 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

updated readme to be more typographically correct

Browse source
This commit is contained in:
Simon Cruanes 2014-12-14 19:55:48 +01:00
parent 8a1d0e89e8
commit 44745e0da2
2 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
AUTHORS.md
View file

@ -7,3 +7,4 @@
- Whitequark (Peter Zotov) - Whitequark (Peter Zotov)
- hcarty (Hezekiah M. Carty) - hcarty (Hezekiah M. Carty)
- struktured (Carmelo Piccione) - struktured (Carmelo Piccione)
- Bernardo da Costa

20
README.md
View file

@ -11,11 +11,11 @@ What is _containers_?
or "companion-cube" because I'm megalomaniac). This part should be or "companion-cube" because I'm megalomaniac). This part should be
usable and should work. For instance, `CCList` contains functions and usable and should work. For instance, `CCList` contains functions and
lists including safe versions of `map` and `append`. lists including safe versions of `map` and `append`.
- Several small additional libraries that completent it: - Several small additional libraries that complement it:
* `containers.data` with additional data structures that don't have an * `containers.data` with additional data structures that don't have an
equivalent in the standard library equivalent in the standard library;
* `containers.io` with utils to handle files and I/O streams * `containers.io` with utils to handle files and I/O streams;
* `containers.iter` with list-like and tree-like iterators * `containers.iter` with list-like and tree-like iterators;
* `containers.string` (in directory `string`) with * `containers.string` (in directory `string`) with
a few packed modules that deal with strings (Levenshtein distance, a few packed modules that deal with strings (Levenshtein distance,
KMP search algorithm, and a few naive utils). Again, modules are independent KMP search algorithm, and a few naive utils). Again, modules are independent
@ -25,7 +25,7 @@ What is _containers_?
that defined a `CCPervasives` module intented to be opened to extend some that defined a `CCPervasives` module intented to be opened to extend some
modules of the stdlib. modules of the stdlib.
- A sub-library with complicated abstractions, `containers.advanced` (with - A sub-library with complicated abstractions, `containers.advanced` (with
a LINQ-like query module, batch operations using GADTs, and others) a LINQ-like query module, batch operations using GADTs, and others).
- A library using [Lwt](https://github.com/ocsigen/lwt/), `containers.lwt`. - A library using [Lwt](https://github.com/ocsigen/lwt/), `containers.lwt`.
Currently only contains experimental, unstable stuff. Currently only contains experimental, unstable stuff.
- Random stuff, with *NO* *GUARANTEE* of even being barely usable or tested, - Random stuff, with *NO* *GUARANTEE* of even being barely usable or tested,
@ -77,7 +77,7 @@ by ocamlfind).
Documentation [here](http://cedeela.fr/~simon/software/containers). Documentation [here](http://cedeela.fr/~simon/software/containers).
- `CCHeap`, a purely functional heap structure. - `CCHeap`, a purely functional heap structure
- `CCVector`, a growable array (pure OCaml, no C) with mutability annotations - `CCVector`, a growable array (pure OCaml, no C) with mutability annotations
- `CCList`, functions on lists, including tail-recursive implementations of `map` and `append` and many other things - `CCList`, functions on lists, including tail-recursive implementations of `map` and `append` and many other things
- `CCArray`, utilities on arrays and slices - `CCArray`, utilities on arrays and slices
@ -162,7 +162,7 @@ access to elements by their index.
- `Univ`, a universal type encoding with affectation - `Univ`, a universal type encoding with affectation
- `FlatHashtbl`, a (deprecated) open addressing hashtable with - `FlatHashtbl`, a (deprecated) open addressing hashtable with
a functorial interface (replaced by PHashtbl) a functorial interface (replaced by PHashtbl)
- `UnionFind`, a functorial imperative Union-Find structure. - `UnionFind`, a functorial imperative Union-Find structure
### Others ### Others
@ -218,7 +218,7 @@ PRs on github are welcome (patches by email too, if you prefer so).
A few guidelines: A few guidelines:
- no dependencies between basic modules (even just for signatures) - no dependencies between basic modules (even just for signatures);
- add `@since` tags for new functions - add `@since` tags for new functions;
- add tests if possible (using `qtest`) - add tests if possible (using `qtest`).