|
1 | | -Tsdl — Thin bindings to SDL for OCaml |
2 | | -===================================== |
| 1 | +# Experimental dune version of TSDL |
3 | 2 |
|
4 | | -Tsdl is an OCaml library providing thin bindings to the cross-platform |
5 | | -[SDL library]. |
6 | | - |
7 | | -Tsdl depends on the C library SDL 2.0.18 (or later), |
8 | | -[ocaml-ctypes][ctypes]. Tsdl is distributed under the ISC license. |
9 | | - |
10 | | -[SDL library]: https://www.libsdl.org/ |
11 | | -[ctypes]: https://github.com/ocamllabs/ocaml-ctypes |
12 | | - |
13 | | -Home page: <http://erratique.ch/software/tsdl> |
14 | | - |
15 | | - |
16 | | -## Installation |
17 | | - |
18 | | -Tsdl needs the C library SDL 2.0.18 or later installed on your |
19 | | -system. Tsdl can be installed with `opam`: |
20 | | - |
21 | | - opam install tsdl |
22 | | - |
23 | | -If you don't use `opam` consult the [`opam`](opam) file for |
24 | | -build instructions and a complete specification of the dependencies. |
25 | | - |
26 | | - |
27 | | -## Documentation |
28 | | - |
29 | | -The documentation can be consulted [online] or via `odig doc tsdl`. |
30 | | - |
31 | | -Questions are welcome but better asked on the [OCaml forum][ocaml-forum] |
32 | | -than on the issue tracker. |
33 | | - |
34 | | -[ocaml-forum]: https://discuss.ocaml.org/ |
35 | | -[online]: https://erratique.ch/software/tsdl/doc/ |
36 | | - |
37 | | -## Sample programs |
38 | | - |
39 | | -Sample programs are located in the `test` directory of the |
40 | | -distribution. They can be built with: |
41 | | - |
42 | | - ./pkg/pkg.ml build --tests true |
43 | | - |
44 | | -and listed with |
45 | | - |
46 | | - ./pkg/pkg.ml test --list |
47 | | - |
48 | | -The resulting binaries are in `_build/test` : |
49 | | - |
50 | | -- `test_tsdl.native`, tests the bindings, the executable should exit with 0. |
51 | | -- `sdlevents.native`, traces SDL events. |
52 | | -- `min.native` a minimal SDL example. |
| 3 | +original: https://github.com/dbuenzli/tsdl |
0 commit comments