Skip to content
This repository has been archived by the owner on Jul 16, 2020. It is now read-only.

Commit

Permalink
Initial commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
kayceesrk committed Jul 27, 2016
0 parents commit 4f0626a
Show file tree
Hide file tree
Showing 17 changed files with 291 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .gitignore
@@ -0,0 +1,8 @@
_build
tmp
*~
\.\#*
\#*#
*.install
*.native
*.byte
4 changes: 4 additions & 0 deletions .merlin
@@ -0,0 +1,4 @@
PKG bytes
S src
S test
B _build/**
1 change: 1 addition & 0 deletions .ocp-indent
@@ -0,0 +1 @@
strict_with=always,match_clause=4,strict_else=never
4 changes: 4 additions & 0 deletions CHANGES.md
@@ -0,0 +1,4 @@
vX.Y.Z YYYY-MM-DD Location
--------------------------

First release.
13 changes: 13 additions & 0 deletions LICENSE.md
@@ -0,0 +1,13 @@
Copyright (c) 2016 KC Sivaramakrishnan

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.
39 changes: 39 additions & 0 deletions README.md
@@ -0,0 +1,39 @@
ezirmin — An easy interface on top of the Irmin library.
-------------------------------------------------------------------------------
%%VERSION%%

ezirmin is TODO

ezirmin is distributed under the ISC license.

Homepage: https://github.com/kayceesrk/ezirmin
Contact: KC Sivaramakrishnan `<sk826@cl.cam.ac.uk>`

## Installation

ezirmin can be installed with `opam`:

opam install ezirmin

If you don't use `opam` consult the [`opam`](opam) file for build
instructions.

## Documentation

The documentation and API reference is automatically generated by
`ocamldoc` from the interfaces. It can be consulted [online][doc]
and there is a generated version in the `doc` directory of the
distribution.

[doc]: http://kcsrk.info//ezirmin/doc

## Sample programs

If you installed ezirmin with `opam` sample programs are located in
the directory `opam config var ezirmin:doc`.

In the distribution sample programs and tests are located in the
[`test`](test) directory of the distribution. They can be built and run
with:

topkg build --tests true && topkg test
4 changes: 4 additions & 0 deletions _tags
@@ -0,0 +1,4 @@
true : bin_annot, safe_string, package(bytes)

<src> : include
<test> : include
1 change: 1 addition & 0 deletions doc/api.odocl
@@ -0,0 +1 @@
Ezirmin
1 change: 1 addition & 0 deletions doc/dev.odocl
@@ -0,0 +1 @@
Ezirmin
112 changes: 112 additions & 0 deletions doc/style.css
@@ -0,0 +1,112 @@
/* Copyright (c) 2016 Daniel C. Bünzli. All rights reserved.
Distributed under the ISC license, see terms at the end of the file. */

/* Reset a few things. */
html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,
a,abbr,acronym,address,big,cite,code,del,dfn,em,font,img,ins,kbd,q,s,samp,
small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,
form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td
{ margin: 0; padding: 0; border: 0 none; outline: 0; font-size: 100%;
font-weight: inherit; font-style:inherit; font-family:inherit;
line-height: inherit; vertical-align: baseline; text-align:inherit;
color:inherit; background: transparent; }

table { border-collapse: collapse; border-spacing: 0; }

/* Basic page layout */

body { font: normal 10pt/1.375em helvetica, arial, sans-serif; text-align:left;
margin: 1.375em 10%; min-width: 40ex; max-width: 72ex;
color: black; background: transparent /* url(line-height-22.gif) */; }

b { font-weight: bold }
em { font-style: italic }

tt, code, pre { font-family: WorkAroundWebKitAndMozilla, monospace;
font-size: 1em; }
pre code { font-size : inherit; }
.codepre { margin-bottom:1.375em /* after code example we introduce space. */ }

.superscript,.subscript
{ font-size : 0.813em; line-height:0; margin-left:0.4ex;}
.superscript { vertical-align: super; }
.subscript { vertical-align: sub; }

/* ocamldoc markup workaround hacks */

hr, hr + br, div + br, center + br, span + br, ul + br, ol + br, pre + br
{ display: none } /* annoying */

div.info + br { display:block}

.codepre br + br { display: none }
h1 + pre { margin-bottom:1.375em} /* Toplevel module description */

/* Sections and document divisions */

/* .navbar { margin-bottom: -1.375em } */
h1 { font-weight: bold; font-size: 1.5em; /* margin-top:1.833em; */
margin-top:0.917em; padding-top:0.875em;
border-top-style:solid; border-width:1px; border-color:#AAA; }
h2 { font-weight: bold; font-size: 1.313em; margin-top: 1.048em }
h3 { font-weight: bold; font-size: 1.125em; margin-top: 1.222em }
h3 { font-weight: bold; font-size: 1em; margin-top: 1.375em}
h4 { font-style: italic; }

/* Used by OCaml's own library documentation. */
h6 { font-weight: bold; font-size: 1.125em; margin-top: 1.222em }
.h7 { font-weight: bold; font-size: 1em; margin-top: 1.375em }

p { margin-top: 1.375em }
pre { margin-top: 1.375em }
.info { margin: 0.458em 0em -0.458em 2em;}/* Description of types values etc. */
td .info { margin:0; padding:0; margin-left: 2em;} /* Description in indexes */

ul, ol { margin-top:0.688em; padding-bottom:0.687em;
list-style-position:outside}
ul + p, ol + p { margin-top: 0em }
ul { list-style-type: square }


/* h2 + ul, h3 + ul, p + ul { } */
ul > li { margin-left: 1.375em; }
ol > li { margin-left: 1.7em; }
/* Links */

a, a:link, a:visited, a:active, a:hover { color : #00B; text-decoration: none }
a:hover { text-decoration : underline }
*:target {background-color: #FFFF99;} /* anchor highlight */

/* Code */

.keyword { font-weight: bold; }
.comment { color : red }
.constructor { color : green }
.string { color : brown }
.warning { color : red ; font-weight : bold }

/* Functors */

.paramstable { border-style : hidden ; padding-bottom:1.375em}
.paramstable code { margin-left: 1ex; margin-right: 1ex }
.sig_block {margin-left: 1em}

/* Images */

img { margin-top: 1.375em }

/*---------------------------------------------------------------------------
Copyright (c) 2016 Daniel C. Bünzli
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.
---------------------------------------------------------------------------*/
18 changes: 18 additions & 0 deletions opam
@@ -0,0 +1,18 @@
opam-version: "1.2"
maintainer: "KC Sivaramakrishnan <sk826@cl.cam.ac.uk>"
authors: ["KC Sivaramakrishnan <sk826@cl.cam.ac.uk>"]
homepage: "https://github.com/kayceesrk/ezirmin"
doc: "http://kcsrk.info//ezirmin/doc"
license: "ISC"
dev-repo: "https://github.com/kayceesrk/ezirmin.git"
bug-reports: "https://github.com/kayceesrk/ezirmin/issues"
tags: []
available: [ ocaml-version >= "4.01.0"]
depends: [
"ocamlfind" {build}
"ocamlbuild" {build}
"topkg" {build} ]
depopts: []
build: [
"ocaml" "pkg/pkg.ml" "build"
"--pinned" pinned ]
7 changes: 7 additions & 0 deletions pkg/META
@@ -0,0 +1,7 @@
description = "An easy interface on top of the Irmin library."
version = "%%VERSION%%"
requires = ""
archive(byte) = "ezirmin.cma"
archive(native) = "ezirmin.cmxa"
plugin(byte) = "ezirmin.cma"
plugin(native) = "ezirmin.cmxs"
9 changes: 9 additions & 0 deletions pkg/pkg.ml
@@ -0,0 +1,9 @@
#!/usr/bin/env ocaml
#use "topfind"
#require "topkg"
open Topkg

let () =
Pkg.describe "ezirmin" @@ fun c ->
Ok [ Pkg.mllib "src/ezirmin.mllib";
Pkg.test "test/test"; ]
21 changes: 21 additions & 0 deletions src/ezirmin.ml
@@ -0,0 +1,21 @@
(*---------------------------------------------------------------------------
Copyright (c) 2016 KC Sivaramakrishnan. All rights reserved.
Distributed under the ISC license, see terms at the end of the file.
%%NAME%% %%VERSION%%
---------------------------------------------------------------------------*)

(*---------------------------------------------------------------------------
Copyright (c) 2016 KC Sivaramakrishnan
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.
---------------------------------------------------------------------------*)
27 changes: 27 additions & 0 deletions src/ezirmin.mli
@@ -0,0 +1,27 @@
(*---------------------------------------------------------------------------
Copyright (c) 2016 KC Sivaramakrishnan. All rights reserved.
Distributed under the ISC license, see terms at the end of the file.
%%NAME%% %%VERSION%%
---------------------------------------------------------------------------*)

(** An easy interface on top of the Irmin library.
{e %%VERSION%% — {{:%%PKG_HOMEPAGE%% }homepage}} *)

(** {1 Ezirmin} *)

(*---------------------------------------------------------------------------
Copyright (c) 2016 KC Sivaramakrishnan
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.
---------------------------------------------------------------------------*)
1 change: 1 addition & 0 deletions src/ezirmin.mllib
@@ -0,0 +1 @@
Ezirmin
21 changes: 21 additions & 0 deletions test/test.ml
@@ -0,0 +1,21 @@
(*---------------------------------------------------------------------------
Copyright (c) 2016 KC Sivaramakrishnan. All rights reserved.
Distributed under the ISC license, see terms at the end of the file.
%%NAME%% %%VERSION%%
---------------------------------------------------------------------------*)

(*---------------------------------------------------------------------------
Copyright (c) 2016 KC Sivaramakrishnan
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.
---------------------------------------------------------------------------*)

0 comments on commit 4f0626a

Please sign in to comment.