From 06c614d2c520262ccf55fdc4bf9c5bfe6bb006e0 Mon Sep 17 00:00:00 2001 From: Swrup Date: Thu, 19 May 2022 23:02:04 +0200 Subject: [PATCH] add usage to readme --- .ocamlformat | 2 +- CHANGES.md | 4 +++- README.md | 11 +++++------ dune-project | 1 + leaflet.opam | 1 + 5 files changed, 11 insertions(+), 8 deletions(-) diff --git a/.ocamlformat b/.ocamlformat index 1b64a37..cec2d50 100644 --- a/.ocamlformat +++ b/.ocamlformat @@ -1,4 +1,4 @@ -version=0.21.0 +version=0.22.4 assignment-operator=end-line break-cases=fit break-fun-decl=wrap diff --git a/CHANGES.md b/CHANGES.md index d9cd2e7..4cff088 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1 +1,3 @@ -## unreleased +## 0.1 + +Initial release. diff --git a/README.md b/README.md index 4c297f0..ffa9b2e 100644 --- a/README.md +++ b/README.md @@ -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/ diff --git a/dune-project b/dune-project index 1613163..1b5b654 100644 --- a/dune-project +++ b/dune-project @@ -29,5 +29,6 @@ (tags (leaflet javascript bindings interactive map openstreetmap)) (depends + brr (ocaml (>= 4.08)))) diff --git a/leaflet.opam b/leaflet.opam index deb4d45..70dc18a 100644 --- a/leaflet.opam +++ b/leaflet.opam @@ -16,6 +16,7 @@ doc: "TODO/leaflet" bug-reports: "https://git.zapashcanon.fr/swrup/leaflet/issues" depends: [ "dune" {>= "2.9"} + "brr" "ocaml" {>= "4.08"} "odoc" {with-doc} ]