diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..992d091 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,13 @@ +Copyright (c) 2026 The bruit programmers + +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. + +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. diff --git a/bruit.opam b/bruit.opam index d2de2ed..9dd6f28 100644 --- a/bruit.opam +++ b/bruit.opam @@ -1,11 +1,12 @@ # This file is generated by dune, edit dune-project instead opam-version: "2.0" -synopsis: "A short synopsis" -description: "A longer description" +synopsis: "A platform-agnostic readline alternative" +description: + "Inspire by linenoise, this library provides a pure OCaml implementation." maintainer: ["Maintainer Name "] authors: ["Author Name "] -license: "LICENSE" -tags: ["add topics" "to describe" "your" "project"] +license: ["BSD-2" "ISC"] +tags: ["shell" "readline"] homepage: "https://github.com/username/reponame" doc: "https://url/to/documentation" bug-reports: "https://github.com/username/reponame/issues" @@ -16,6 +17,7 @@ depends: [ "ocaml" "odoc" {with-doc} ] +depopts: ["brr" "terminal"] build: [ ["dune" "subst"] {dev} [ diff --git a/dune-project b/dune-project index 480ad60..3bcc4f4 100644 --- a/dune-project +++ b/dune-project @@ -11,19 +11,23 @@ (maintainers "Maintainer Name ") -(license LICENSE) +(license BSD-2 ISC) (documentation https://url/to/documentation) (package (name bruit) - (synopsis "A short synopsis") - (description "A longer description") + (synopsis "A platform-agnostic readline alternative") + (description "Inspire by linenoise, this library provides a pure OCaml implementation.") + (depopts + brr + terminal + ) (depends fmt astring ocaml) (tags - ("add topics" "to describe" your project))) + ("shell" "readline" ))) ; See the complete stanza docs at https://dune.readthedocs.io/en/stable/reference/dune-project/index.html