better readme; rm empty test/
This commit is contained in:
parent
a67ff6acab
commit
96b4f963a6
5 changed files with 15 additions and 18 deletions
22
README.md
22
README.md
|
|
@ -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
|
||||||
|
|
|
||||||
|
|
@ -5,6 +5,8 @@
|
||||||
|
|
||||||
(name leaflet)
|
(name leaflet)
|
||||||
|
|
||||||
|
(generate_opam_files true)
|
||||||
|
|
||||||
(license BSD-2-Clause)
|
(license BSD-2-Clause)
|
||||||
|
|
||||||
(authors "pukkamustard <pukkamustard@posteo.net>" "swrup <swrup@protonmail.com>" "Léo Andrès <contact@ndrs.fr>")
|
(authors "pukkamustard <pukkamustard@posteo.net>" "swrup <swrup@protonmail.com>" "Léo Andrès <contact@ndrs.fr>")
|
||||||
|
|
@ -18,10 +20,6 @@
|
||||||
|
|
||||||
(bug_reports https://git.zapashcanon.fr/swrup/leaflet/issues)
|
(bug_reports https://git.zapashcanon.fr/swrup/leaflet/issues)
|
||||||
|
|
||||||
(documentation TODO/leaflet)
|
|
||||||
|
|
||||||
(generate_opam_files true)
|
|
||||||
|
|
||||||
(package
|
(package
|
||||||
(name leaflet)
|
(name leaflet)
|
||||||
(synopsis "Bindings for the Leaflet JavaScript library")
|
(synopsis "Bindings for the Leaflet JavaScript library")
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,6 @@ authors: [
|
||||||
license: "BSD-2-Clause"
|
license: "BSD-2-Clause"
|
||||||
tags: ["leaflet" "javascript" "bindings" "interactive" "map" "openstreetmap"]
|
tags: ["leaflet" "javascript" "bindings" "interactive" "map" "openstreetmap"]
|
||||||
homepage: "https://git.zapashcanon.fr/swrup/leaflet"
|
homepage: "https://git.zapashcanon.fr/swrup/leaflet"
|
||||||
doc: "TODO/leaflet"
|
|
||||||
bug-reports: "https://git.zapashcanon.fr/swrup/leaflet/issues"
|
bug-reports: "https://git.zapashcanon.fr/swrup/leaflet/issues"
|
||||||
depends: [
|
depends: [
|
||||||
"dune" {>= "2.9"}
|
"dune" {>= "2.9"}
|
||||||
|
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
(test
|
|
||||||
(name test)
|
|
||||||
(modules test))
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
let () = assert true (* TODO *)
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue