From 7dc0d9a70d6450cbd366d1111508df62c01cd37c Mon Sep 17 00:00:00 2001 From: zapashcanon Date: Fri, 5 Nov 2021 14:13:28 +0100 Subject: [PATCH] first commit --- .gitignore | 1 + .ocamlformat | 61 +++++++++++++++++++++++++++++++++++++++++++++++++ CHANGES.md | 1 + LICENSE.md | 8 +++++++ README.md | 40 ++++++++++++++++++++++++++++++++ doc/dune | 3 +++ doc/index.mld | 19 +++++++++++++++ dune-project | 25 ++++++++++++++++++++ example/dune | 3 +++ example/main.ml | 1 + src/dune | 3 +++ src/permap.ml | 1 + test/dune | 3 +++ test/main.ml | 1 + 14 files changed, 170 insertions(+) create mode 100644 .gitignore create mode 100644 .ocamlformat create mode 100644 CHANGES.md create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 doc/dune create mode 100644 doc/index.mld create mode 100644 dune-project create mode 100644 example/dune create mode 100644 example/main.ml create mode 100644 src/dune create mode 100644 src/permap.ml create mode 100644 test/dune create mode 100644 test/main.ml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e35d885 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +_build diff --git a/.ocamlformat b/.ocamlformat new file mode 100644 index 0000000..4ee2978 --- /dev/null +++ b/.ocamlformat @@ -0,0 +1,61 @@ +version=0.19.0 +align-cases=false +align-constructors-decl=false +align-variants-decl=false +assignment-operator=end-line +break-before-in=fit-or-vertical +break-cases=all +break-collection-expressions=fit-or-vertical +break-fun-decl=wrap +break-fun-sig=wrap +break-infix=wrap +break-infix-before-func=false +break-separators=before +break-sequences=true +break-string-literals=auto +break-struct=force +cases-exp-indent=2 +cases-matching-exp-indent=normal +disambiguate-non-breaking-match=false +doc-comments=before +doc-comments-padding=2 +doc-comments-tag-only=default +dock-collection-brackets=false +exp-grouping=preserve +extension-indent=2 +field-space=loose +function-indent=2 +function-indent-nested=never +if-then-else=k-r +indent-after-in=0 +indicate-multiline-delimiters=space +indicate-nested-or-patterns=unsafe-no +infix-precedence=indent +leading-nested-match-parens=false +let-and=sparse +let-binding-indent=2 +let-binding-spacing=compact +let-module=compact +margin=80 +match-indent=0 +match-indent-nested=never +max-indent=68 +module-item-spacing=sparse +nested-match=wrap +ocp-indent-compat=false +parens-ite=false +parens-tuple=always +parens-tuple-patterns=multi-line-only +parse-docstrings=true +sequence-blank-line=preserve-one +sequence-style=terminator +single-case=compact +space-around-arrays=true +space-around-lists=true +space-around-records=true +space-around-variants=true +stritem-extension-indent=0 +type-decl=sparse +type-decl-indent=2 +wrap-comments=false +wrap-fun-args=true diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 0000000..d9cd2e7 --- /dev/null +++ b/CHANGES.md @@ -0,0 +1 @@ +## unreleased diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..1ead8d4 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,8 @@ +The ISC License (ISC) +===================== + +Copyright © 2021, TODO + +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/README.md b/README.md new file mode 100644 index 0000000..b58fe9f --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# permap + +permap is an [OCaml] executable/library to TODO. + +## Installation + +`permap` can be installed with [opam]: + +```sh +opam install permap +``` + +If you don't have `opam`, you can install it following the [how to install opam] guide. + +If you can't or don't want to use `opam`, consult the [opam file] for build instructions. + +## Quickstart + +```ocaml +let () = Format.printf "TODO@." +``` + +For more, have a look at the [example] folder, at the [documentation] or at the [test suite]. + +## About + +- [LICENSE] +- [CHANGELOG] + +[CHANGELOG]: ./CHANGES.md +[example]: ./example/ +[LICENSE]: ./LICENSE.md +[opam file]: ./permap.opam +[test suite]: ./test/ + +[documentation]: TODO +[how to install opam]: https://opam.ocaml.org/doc/Install.html +[OCaml]: https://ocaml.org +[opam]: https://opam.ocaml.org/ +[permap]: TODO diff --git a/doc/dune b/doc/dune new file mode 100644 index 0000000..bae3535 --- /dev/null +++ b/doc/dune @@ -0,0 +1,3 @@ +(documentation + (package permap) + (mld_files index)) diff --git a/doc/index.mld b/doc/index.mld new file mode 100644 index 0000000..726e6fb --- /dev/null +++ b/doc/index.mld @@ -0,0 +1,19 @@ +{0 permap} + +{{:https://TODO} permap} is an {{:https://ocaml.org} OCaml} library/executable to TODO. + +{1:api API} + + +{!modules: +Permap +} + + +{1:private_api Private API} + +You shouldn't have to use any of these modules, they're used internally only. + +{!modules: +TODO +} diff --git a/dune-project b/dune-project new file mode 100644 index 0000000..9c4b643 --- /dev/null +++ b/dune-project @@ -0,0 +1,25 @@ +(lang dune 2.8) + +(name permap) + +(license ISC) + +(authors "TODO") + +(maintainers "TODO") + +;(source +; (github TODO/permap)) + +(generate_opam_files true) + +(package + (name permap) + (synopsis "OCaml library/executable to TODO") + (description + "permap is an OCaml library/executable to TODO.") + (tags + (permap TODO TODO TODO TODO)) + (depends + (ocaml + (>= 4.08)))) diff --git a/example/dune b/example/dune new file mode 100644 index 0000000..e36b142 --- /dev/null +++ b/example/dune @@ -0,0 +1,3 @@ +(executable + (name main) + (modules main)) diff --git a/example/main.ml b/example/main.ml new file mode 100644 index 0000000..16c9b9f --- /dev/null +++ b/example/main.ml @@ -0,0 +1 @@ +let () = Format.printf "TODO@." diff --git a/src/dune b/src/dune new file mode 100644 index 0000000..78a6837 --- /dev/null +++ b/src/dune @@ -0,0 +1,3 @@ +(executable + (name permap) + (modules permap)) diff --git a/src/permap.ml b/src/permap.ml new file mode 100644 index 0000000..fb1bb4c --- /dev/null +++ b/src/permap.ml @@ -0,0 +1 @@ +let () = Format.printf "Hello!@." diff --git a/test/dune b/test/dune new file mode 100644 index 0000000..81cf59e --- /dev/null +++ b/test/dune @@ -0,0 +1,3 @@ +(test + (name main) + (modules main)) diff --git a/test/main.ml b/test/main.ml new file mode 100644 index 0000000..29ef5f9 --- /dev/null +++ b/test/main.ml @@ -0,0 +1 @@ +let () = assert true (* TODO *)