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
42
43
44
45
46
47
48
49
50
51
52
|
# OCaml Bitstring Library
[](https://travis-ci.org/xguerin/bitstring)
```
Copyright (C) 2008-2016 Red Hat Inc, Richard W.M. Jones.
Copyright (C) 2016-2018 Red Hat Inc, Richard W.M. Jones, Xavier R. Guerin.
```
The original `README` content can be found in the `README.orig` file.
## Documentation
The documentation is located [here](https://bitstring.software).
## How to install
```
opam install bitstring
opam install ppx_bitstring
```
## How to use
### Ocamlfind
```
ocamlfind c -package bitstring -package ppx_bitstring -linkpkg ...
```
### Dune
```lisp
(executable
((name foo)
(libraries (bitstring))
(preprocess (pps (ppx_bitstring)))
))
```
## How to build
### Dependencies
Required packages are detailed in the `dune-project` file.
### Building the project
```
$ dune build
```
### Running the tests
```
$ dune runtest
```
## License
The library is licensed under the LGPL v2 or later, with the OCaml linking
exception. See the file `COPYING.LIB` for full terms. Programs are licensed under
the GPL v2 or later. See the file `COPYING` for full terms. All examples and tests
are public domain.
|
