Skip to content
This repository was archived by the owner on Jun 26, 2025. It is now read-only.

Commit 3cab1aa

Browse files
committed
add information to readme
1 parent af16d19 commit 3cab1aa

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,33 @@
11

22
[OpenCV](http://opencv.org/) bindings for [OCaml](http://ocaml.org/).
3+
4+
## Quick start
5+
6+
Run `make` to install the library with ocamlfind. You must have OpenCV
7+
installed on your system.
8+
9+
Run `make demos/basic` to run the demo. This demo requires you to
10+
provide a video file `demos/basic/test.mp4` as input. It also requires
11+
you to install the `owl` opam package.
12+
13+
Run `make docs` to generate documentation. Open
14+
`opencv.docdir/index.html` to view.
15+
16+
## Goals
17+
18+
- Provide access to the full OpenCV API through OCaml
19+
- Make it possible to use OpenCV API calls as pure functions
20+
- Use auto-generation of bindings as much as possible
21+
22+
## Caveats
23+
24+
The bindings are currently for a small subset of the OpenCV API (core,
25+
imgproc, videoio, and highgui), but the plan is to eventually support
26+
the entire API.
27+
28+
Tested with OpenCV 4.3.0. Should work fine with any OpenCV 4.x, but
29+
modifications may be necessary to work with older versions.
30+
31+
OWL is not required to use the OpenCV bindings, but it is recommended
32+
because the mat type is compatible with OWL type
33+
`Dense.Ndarray.Generic`; OWL serves a role similar to numpy for Python.

0 commit comments

Comments
 (0)