kumikode/leaflet
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

add usage to readme

Browse source
This commit is contained in:
Swrup 2022-05-19 23:02:04 +02:00
parent 38c0d5ef53
commit 06c614d2c5
5 changed files with 11 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.ocamlformat
View file

@ -1,4 +1,4 @@
version=0.21.0 version=0.22.4
assignment-operator=end-line assignment-operator=end-line
break-cases=fit break-cases=fit
break-fun-decl=wrap break-fun-decl=wrap

4
CHANGES.md
View file

@ -1 +1,3 @@
## unreleased ## 0.1
Initial release.

11
README.md
View file

@ -14,13 +14,12 @@ If you don't have `opam`, you can install it following the [how to install opam]
If you can't or don't want to use `opam`, consult the [opam file] for build instructions. If you can't or don't want to use `opam`, consult the [opam file] for build instructions.
## Quickstart ## Usage
```ocaml Have a look at the [example] folder.
let () = Format.printf "TODO@." The documentation can be consulted via `odig doc leaflet`.
```
For more, have a look at the [example] folder, at the [documentation] or at the [test suite]. You will also need [leaflet's files] (CSS and images).
## About ## About
@ -35,9 +34,9 @@ leaflet's original code was taken from a [NGI0 funded project]
[opam file]: ./leaflet.opam [opam file]: ./leaflet.opam
[test suite]: ./test [test suite]: ./test
[documentation]: TODO/leaflet
[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
[NGI0 funded project]: https://nlnet.nl/project/openEngiadina/ [NGI0 funded project]: https://nlnet.nl/project/openEngiadina/

1
dune-project
View file

@ -29,5 +29,6 @@
(tags (tags
(leaflet javascript bindings interactive map openstreetmap)) (leaflet javascript bindings interactive map openstreetmap))
(depends (depends
brr
(ocaml (ocaml
(>= 4.08)))) (>= 4.08))))

1
leaflet.opam
View file

@ -16,6 +16,7 @@ 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"}
"brr"
"ocaml" {>= "4.08"} "ocaml" {>= "4.08"}
"odoc" {with-doc} "odoc" {with-doc}
] ]