export, install and describe the S-expr module

This commit is contained in:
Simon Cruanes 2013-02-05 00:00:44 +01:00
parent 14d651b836
commit ac2fb8129c
3 changed files with 10 additions and 7 deletions

6
META
View file

@ -1,6 +1,6 @@
name="sequence"
version="0.1"
description="Abstract sequences of elements, for conversion into and from data structures"
description="Abstract sequences of elements, for conversion into and from data structures, and a tiny S-expression library."
requires=""
archive(byte) = "sequence.cma"
archive(native) = "sequence.cmxa"
archive(byte) = "sequence.cma sexpr.cma"
archive(native) = "sequence.cmxa sexpr.cmxa"

View file

@ -1,9 +1,9 @@
NAME = sequence
DOC = sequence.docdir/index.html
TARGETS = sequence.cma sequence.cmxa sequence.cmi sequence.a
TARGETS = sequence.cma sequence.cmxa sequence.cmi sequence.a sexpr.cma sexpr.cmxa sexpr.cmi
LIB = $(addprefix _build/, $(TARGETS))
INSTALL = $(LIB) sequence.mli
INSTALL = $(LIB) sequence.mli sexpr.mli
all:
ocamlbuild tests.native $(TARGETS) $(DOC)

View file

@ -1,7 +1,9 @@
Sequence
========
Simple sequence abstract datatype, intented to transfer a finite number of elements from one data structure to another.
Simple sequence abstract datatype, intented to transfer a finite number of
elements from one data structure to another. It also provides a tiny
library for S-expressions, convertible to streams of tokens, and conversely.
Build
=====
@ -11,7 +13,8 @@ You need OCaml, say OCaml 3.12 or OCaml 4.0.
$ make
To see how to use it, check `tests.ml`. `sequence.ml` has a few examples of how to convert
data structures into sequences, and conversely.
data structures into sequences, and conversely. The module `sexpr.mli` exposes the interface
of the S-expression library.
License
=======