From a0dc553c7dc8eb3420e372788c9fbb0239528eac Mon Sep 17 00:00:00 2001 From: Swrup Date: Tue, 12 Apr 2022 13:46:37 +0200 Subject: [PATCH] license --- LICENSE.md | 11 ++++++----- README.md | 7 +++++-- dune-project | 18 +++++++++--------- leaflet.opam | 23 ++++++++++++++--------- src/event.ml | 2 ++ src/event.mli | 2 ++ src/global.ml | 2 ++ src/latlng.ml | 2 ++ src/latlng.mli | 2 ++ src/layer.ml | 2 ++ src/layer.mli | 2 ++ src/map.ml | 2 ++ src/map.mli | 2 ++ src/popup.ml | 2 ++ src/popup.mli | 2 ++ 15 files changed, 56 insertions(+), 25 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index c0fd71b..7662a7c 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,8 +1,9 @@ -The ISC License (ISC) -===================== +Copyright 2022 pukkamustard , swrup , zapashcanon -Copyright © 2022, TODO +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index e628def..4c297f0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # leaflet -[leaflet] is an [OCaml] executable/library to TODO. +`leaflet` is an [OCaml] bindings library for the [Leaflet] JavaScript library. ## Installation @@ -24,6 +24,8 @@ For more, have a look at the [example] folder, at the [documentation] or at the ## About +leaflet's original code was taken from a [NGI0 funded project] + - [LICENSE] - [CHANGELOG] @@ -37,4 +39,5 @@ For more, have a look at the [example] folder, at the [documentation] or at the [how to install opam]: https://opam.ocaml.org/doc/Install.html [OCaml]: https://ocaml.org [opam]: https://opam.ocaml.org/ -[leaflet]: TODO/leaflet +[Leaflet]: https://leafletjs.com/ +[NGI0 funded project]: https://nlnet.nl/project/openEngiadina/ diff --git a/dune-project b/dune-project index 5220076..1613163 100644 --- a/dune-project +++ b/dune-project @@ -4,18 +4,18 @@ (name leaflet) -(license ISC) +(license BSD-2-Clause) -(authors "TODO") +(authors "pukkamustard " "swrup " "Léo Andrès ") -(maintainers "TODO") +(maintainers "swrup ") (source - (uri TODO/leaflet)) + (uri git+https://git.zapashcanon.fr/swrup/leaflet.git)) -(homepage TODO/leaflet) +(homepage https://git.zapashcanon.fr/swrup/leaflet) -(bug_reports TODO/leaflet) +(bug_reports https://git.zapashcanon.fr/swrup/leaflet/issues) (documentation TODO/leaflet) @@ -23,11 +23,11 @@ (package (name leaflet) - (synopsis "OCaml library/executable to TODO") + (synopsis "Bindings for the Leaflet JavaScript library") (description - "leaflet is an OCaml library/executable to TODO.") + "leaflet is an OCaml bindings library for the Leaflet JavaScript library.") (tags - (leaflet TODO TODO TODO TODO)) + (leaflet javascript bindings interactive map openstreetmap)) (depends (ocaml (>= 4.08)))) diff --git a/leaflet.opam b/leaflet.opam index 996aee0..deb4d45 100644 --- a/leaflet.opam +++ b/leaflet.opam @@ -1,14 +1,19 @@ # This file is generated by dune, edit dune-project instead opam-version: "2.0" -synopsis: "OCaml library/executable to TODO" -description: "leaflet is an OCaml library/executable to TODO." -maintainer: ["TODO"] -authors: ["TODO"] -license: "ISC" -tags: ["leaflet" "TODO" "TODO" "TODO" "TODO"] -homepage: "TODO/leaflet" +synopsis: "Bindings for the Leaflet JavaScript library" +description: + "leaflet is an OCaml bindings library for the Leaflet JavaScript library." +maintainer: ["swrup "] +authors: [ + "pukkamustard " + "swrup " + "Léo Andrès " +] +license: "BSD-2-Clause" +tags: ["leaflet" "javascript" "bindings" "interactive" "map" "openstreetmap"] +homepage: "https://git.zapashcanon.fr/swrup/leaflet" doc: "TODO/leaflet" -bug-reports: "TODO/leaflet" +bug-reports: "https://git.zapashcanon.fr/swrup/leaflet/issues" depends: [ "dune" {>= "2.9"} "ocaml" {>= "4.08"} @@ -30,4 +35,4 @@ build: [ ] ["dune" "install" "-p" name "--create-install-files" name] ] -dev-repo: "TODO/leaflet" +dev-repo: "git+https://git.zapashcanon.fr/swrup/leaflet.git" diff --git a/src/event.ml b/src/event.ml index 6b456d2..2b39417 100644 --- a/src/event.ml +++ b/src/event.ml @@ -1,3 +1,5 @@ +(* BSD-2-Clause License *) + type _ t = | Keyboard : Jv.t -> [> `Keyboard ] t | Mouse : Jv.t -> [> `Mouse ] t diff --git a/src/event.mli b/src/event.mli index 9592bfb..8723a09 100644 --- a/src/event.mli +++ b/src/event.mli @@ -1,3 +1,5 @@ +(* BSD-2-Clause License *) + type _ t = | Keyboard : Jv.t -> [> `Keyboard ] t | Mouse : Jv.t -> [> `Mouse ] t diff --git a/src/global.ml b/src/global.ml index c209f3d..a4ebdfa 100644 --- a/src/global.ml +++ b/src/global.ml @@ -1,3 +1,5 @@ +(* BSD-2-Clause License *) + let leaflet = match Jv.(find global "L") with | Some l -> l diff --git a/src/latlng.ml b/src/latlng.ml index 6611746..400200b 100644 --- a/src/latlng.ml +++ b/src/latlng.ml @@ -1,3 +1,5 @@ +(* BSD-2-Clause License *) + type t = Jv.t let create lat lng = diff --git a/src/latlng.mli b/src/latlng.mli index c63a970..9097890 100644 --- a/src/latlng.mli +++ b/src/latlng.mli @@ -1,3 +1,5 @@ +(* BSD-2-Clause License *) + type t val create : float -> float -> t diff --git a/src/layer.ml b/src/layer.ml index fd9b07a..9808ebb 100644 --- a/src/layer.ml +++ b/src/layer.ml @@ -1,3 +1,5 @@ +(* BSD-2-Clause License *) + type _ t = | Basic : Jv.t -> [> `Basic ] t | Geojson : Jv.t -> [> `Geojson ] t diff --git a/src/layer.mli b/src/layer.mli index 0baf3fd..b3816e6 100644 --- a/src/layer.mli +++ b/src/layer.mli @@ -1,3 +1,5 @@ +(* BSD-2-Clause License *) + type _ t = | Basic : Jv.t -> [> `Basic ] t | Geojson : Jv.t -> [> `Geojson ] t diff --git a/src/map.ml b/src/map.ml index 57598f4..259efeb 100644 --- a/src/map.ml +++ b/src/map.ml @@ -1,3 +1,5 @@ +(* BSD-2-Clause License *) + type t = Jv.t let of_jv = Fun.id diff --git a/src/map.mli b/src/map.mli index f4f6f2b..96795cb 100644 --- a/src/map.mli +++ b/src/map.mli @@ -1,3 +1,5 @@ +(* BSD-2-Clause License *) + type t val create : ?options:Jv.t -> string -> t diff --git a/src/popup.ml b/src/popup.ml index fb0264c..5447cd4 100644 --- a/src/popup.ml +++ b/src/popup.ml @@ -1,3 +1,5 @@ +(* BSD-2-Clause License *) + type t = Jv.t let popup = Jv.call Global.leaflet "popup" [||] diff --git a/src/popup.mli b/src/popup.mli index 65e5dfc..ee5df35 100644 --- a/src/popup.mli +++ b/src/popup.mli @@ -1,3 +1,5 @@ +(* BSD-2-Clause License *) + type t val set_latlng : Latlng.t -> unit