Browse Source

first commit

master
zapashcanon 5 months ago
commit
625ad5c83a
Signed by: zapashcanon GPG Key ID: 8981C3C62D1D28F1
  1. 1
      .gitignore
  2. 42
      .ocamlformat
  3. 1
      CHANGES.md
  4. 8
      LICENSE.md
  5. 40
      README.md
  6. 3
      doc/dune
  7. 17
      doc/index.mld
  8. 33
      dune-project
  9. 3
      example/dune
  10. 1
      example/main.ml
  11. 3
      src/dune
  12. 1
      src/voxflow.ml
  13. 3
      test/dune
  14. 1
      test/test.ml
  15. 33
      voxflow.opam

1
.gitignore

@ -0,0 +1 @@
_build

42
.ocamlformat

@ -0,0 +1,42 @@
version=0.20.1
assignment-operator=end-line
break-cases=fit
break-fun-decl=wrap
break-fun-sig=wrap
break-infix=wrap
break-infix-before-func=false
break-separators=before
break-sequences=true
cases-exp-indent=2
cases-matching-exp-indent=normal
doc-comments=before
doc-comments-padding=2
doc-comments-tag-only=default
dock-collection-brackets=false
exp-grouping=preserve
field-space=loose
if-then-else=compact
indicate-multiline-delimiters=space
indicate-nested-or-patterns=unsafe-no
infix-precedence=indent
leading-nested-match-parens=false
let-and=sparse
let-binding-spacing=compact
let-module=compact
margin=80
max-indent=68
module-item-spacing=sparse
ocp-indent-compat=false
parens-ite=false
parens-tuple=always
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
type-decl=sparse
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 © 2022, Léo Andrès <contact@ndrs.fr>
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 @@
# voxflow
[voxflow] is an [OCaml] executable/library to TODO.
## Installation
`voxflow` can be installed with [opam]:
```sh
opam install voxflow
```
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]: ./voxflow.opam
[test suite]: ./test
[documentation]: https://doc.zapashcanon.fr/voxflow
[how to install opam]: https://opam.ocaml.org/doc/Install.html
[OCaml]: https://ocaml.org
[opam]: https://opam.ocaml.org/
[voxflow]: https://git.zapashcanon.fr/zapashcanon/voxflow

3
doc/dune

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

17
doc/index.mld

@ -0,0 +1,17 @@
{0 voxflow}
{{:https://https://git.zapashcanon.fr/zapashcanon/voxflow} voxflow} is an {{:https://ocaml.org} OCaml} library/executable to TODO.
{1:api API}
{!modules:
Voxflow
}
{1:private_api Private API}
You shouldn't have to use any of these modules, they're used internally only.
{!modules:
TODO
}

33
dune-project

@ -0,0 +1,33 @@
(lang dune 2.9)
(implicit_transitive_deps false)
(name voxflow)
(license ISC)
(authors "Léo Andrès <contact@ndrs.fr>")
(maintainers "Léo Andrès <contact@ndrs.fr>")
(source
(uri git+https://git.zapashcanon.fr/zapashcanon/voxflow.git))
(homepage https://git.zapashcanon.fr/zapashcanon/voxflow)
(bug_reports https://git.zapashcanon.fr/zapashcanon/voxflow/issues)
(documentation https://doc.zapashcanon.fr/voxflow)
(generate_opam_files true)
(package
(name voxflow)
(synopsis "OCaml library/executable to TODO")
(description
"voxflow is an OCaml library/executable to TODO.")
(tags
(voxflow 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 voxflow)
(modules voxflow))

1
src/voxflow.ml

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

3
test/dune

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

1
test/test.ml

@ -0,0 +1 @@
let () = assert true (* TODO *)

33
voxflow.opam

@ -0,0 +1,33 @@
# This file is generated by dune, edit dune-project instead
opam-version: "2.0"
synopsis: "OCaml library/executable to TODO"
description: "voxflow is an OCaml library/executable to TODO."
maintainer: ["Léo Andrès <contact@ndrs.fr>"]
authors: ["Léo Andrès <contact@ndrs.fr>"]
license: "ISC"
tags: ["voxflow" "TODO" "TODO" "TODO" "TODO"]
homepage: "https://git.zapashcanon.fr/zapashcanon/voxflow"
doc: "https://doc.zapashcanon.fr/voxflow"
bug-reports: "https://git.zapashcanon.fr/zapashcanon/voxflow/issues"
depends: [
"dune" {>= "2.9"}
"ocaml" {>= "4.08"}
"odoc" {with-doc}
]
build: [
["dune" "subst"] {dev}
[
"dune"
"build"
"-p"
name
"-j"
jobs
"--promote-install-files=false"
"@install"
"@runtest" {with-test}
"@doc" {with-doc}
]
["dune" "install" "-p" name "--create-install-files" name]
]
dev-repo: "git+https://git.zapashcanon.fr/zapashcanon/voxflow.git"
Loading…
Cancel
Save