raphael-proust / astring Goto Github PK

Release %%VERSION%%

Astring exposes an alternative String module for OCaml. This module tries to balance minimality and expressiveness for basic, index-free, string processing and provides types and functions for substrings, string sets and string maps.

Remaining compatible with the OCaml String module is a non-goal. The String module exposed by Astring has exception safe functions, removes deprecated and rarely used functions, alters some signatures and names, adds a few missing functions and fully exploits OCaml's newfound string immutability.

Astring depends only on the OCaml standard library. It is distributed under the BSD3 license.

Home page: http://erratique.ch/software/astring
Contact: Daniel Bünzli <daniel.buenzl [email protected]>

Astring can be installed with opam:

opam install astring

If you don't use opam consult the opam file for build instructions.

The documentation and API reference is automatically generated by ocamldoc from the interfaces. It can be consulted online and there is a generated version in the doc directory of the distribution.

If you installed Astring with opam sample programs are located in the directory opam config var astring:doc.

In the distribution sample programs are located in the test directory of the distribution. They can be built with:

ocamlbuild -use-ocamlfind test/tests.otarget

The resulting binaries are in _build/test.

• test.native tests the library, nothing should fail.