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 21bf82239b
commit 0a5f5519da
5 changed files with 11 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

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.
## Quickstart
## Usage
```ocaml
let () = Format.printf "TODO@."
```
Have a look at the [example] folder.
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
@ -35,9 +34,9 @@ leaflet's original code was taken from a [NGI0 funded project]
[opam file]: ./leaflet.opam
[test suite]: ./test
[documentation]: TODO/leaflet
[how to install opam]: https://opam.ocaml.org/doc/Install.html
[OCaml]: https://ocaml.org
[opam]: https://opam.ocaml.org/
[Leaflet]: https://leafletjs.com/
[leaflet's files]: https://leafletjs.com/download.html
[NGI0 funded project]: https://nlnet.nl/project/openEngiadina/