Browse Source

first commit

pull/1/head
zapashcanon 8 months ago
commit
7dc0d9a70d
Signed by: zapashcanon GPG Key ID: 8981C3C62D1D28F1
  1. 1
      .gitignore
  2. 61
      .ocamlformat
  3. 1
      CHANGES.md
  4. 8
      LICENSE.md
  5. 40
      README.md
  6. 3
      doc/dune
  7. 19
      doc/index.mld
  8. 25
      dune-project
  9. 3
      example/dune
  10. 1
      example/main.ml
  11. 3
      src/dune
  12. 1
      src/permap.ml
  13. 3
      test/dune
  14. 1
      test/main.ml

1
.gitignore

@ -0,0 +1 @@
_build

61
.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

1
CHANGES.md

@ -0,0 +1 @@
## unreleased

8
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.

40
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

3
doc/dune

@ -0,0 +1,3 @@
(documentation
(package permap)
(mld_files index))

19
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
}

25
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))))

3
example/dune

@ -0,0 +1,3 @@
(executable
(name main)
(modules main))

1
example/main.ml

@ -0,0 +1 @@
let () = Format.printf "TODO@."

3
src/dune

@ -0,0 +1,3 @@
(executable
(name permap)
(modules permap))

1
src/permap.ml

@ -0,0 +1 @@
let () = Format.printf "Hello!@."

3
test/dune

@ -0,0 +1,3 @@
(test
(name main)
(modules main))

1
test/main.ml

@ -0,0 +1 @@
let () = assert true (* TODO *)
Loading…
Cancel
Save