better readme; rm empty test/

This commit is contained in:
Swrup 2026-03-19 22:01:05 +01:00
parent 4265cdce92
commit a099b05592
3 changed files with 13 additions and 13 deletions

View file

@ -1,6 +1,6 @@
# leaflet # leaflet
`leaflet` is an [OCaml] bindings library for the [Leaflet] JavaScript library. `leaflet` is an [OCaml] bindings library for the [Leaflet] JavaScript library (v1.9.4).
## Installation ## Installation
@ -16,27 +16,31 @@ If you can't or don't want to use `opam`, consult the [opam file] for build inst
## Usage ## Usage
Have a look at the [example] folder. The library use `dune-site` to install [leaflet's files] (CSS and images).
The documentation can be consulted via `odig doc leaflet`.
You will also need [leaflet's files] (CSS and images). Have a look at the [example] folder.
It use [tiny_httpd] to provide a simple web page with a map that use [OpenStreetMap] tiles:
```sh
dune build @install
dune exec example/server.exe
```
## About ## About
leaflet's original code was taken from a [NGI0 funded project] This library started off from the code of a [NGI0 funded project]
- [LICENSE] - [LICENSE]
- [CHANGELOG] - [CHANGELOG]
[CHANGELOG]: ./CHANGES.md [CHANGELOG]: ./CHANGES.md
[example]: ./example
[LICENSE]: ./LICENSE.md [LICENSE]: ./LICENSE.md
[opam file]: ./leaflet.opam [opam file]: ./leaflet.opam
[test suite]: ./test
[how to install opam]: https://opam.ocaml.org/doc/Install.html [how to install opam]: https://opam.ocaml.org/doc/Install.html
[OCaml]: https://ocaml.org [OCaml]: https://ocaml.org
[opam]: https://opam.ocaml.org/ [opam]: https://opam.ocaml.org/
[Leaflet]: https://leafletjs.com/ [Leaflet]: https://leafletjs.com/
[leaflet's files]: https://leafletjs.com/download.html [Leaflet's files]: ./src/vendor/
[NGI0 funded project]: https://nlnet.nl/project/openEngiadina/ [NGI0 funded project]: https://nlnet.nl/project/openEngiadina/
[tiny_httpd]: https://github.com/c-cube/tiny_httpd
[example]: ./example/
[OpenStreetMap]: https://www.openstreetmap.org

View file

@ -1,3 +0,0 @@
(test
(name test)
(modules test))

View file

@ -1 +0,0 @@
let () = assert true (* TODO *)