File: README.md

package info (click to toggle)
ocaml-astring 0.8.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 396 kB
  • sloc: ml: 4,475; makefile: 16
file content (41 lines) | stat: -rw-r--r-- 1,345 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
Astring — Alternative String module for OCaml
-------------------------------------------------------------------------------
v0.8.5

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 ISC license.

Home page: http://erratique.ch/software/astring  

## Installation

Astring can be installed with `opam`:

    opam install astring

If you don't use `opam` consult the [`opam`](opam) file for build
instructions.

## Documentation

The documentation and API reference is automatically generated by
`ocamldoc` from the interfaces. It can be consulted [online][doc]
or via `odig doc astring`.

[doc]: http://erratique.ch/software/astring/doc/

## Sample programs

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