From 8a1d0e89e8ba9d947e1bb6d4d944eb96cc68223a Mon Sep 17 00:00:00 2001
From: Simon Cruanes <simon.cruanes.2007@m4x.org>
Date: Sat, 13 Dec 2014 03:52:32 +0100
Subject: [PATCH] intro documentation updated; fixed some .mli

---
 core/CCIO.mli     |   7 +--
 core/CCString.mli |   1 +
 doc/intro.txt     | 115 ++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 120 insertions(+), 3 deletions(-)

diff --git a/core/CCIO.mli b/core/CCIO.mli
index 1e29f134..80699140 100644
--- a/core/CCIO.mli
+++ b/core/CCIO.mli
@@ -29,9 +29,6 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 Simple utilities to deal with basic Input/Output tasks in a resource-safe
 way. For advanced IO tasks, the user is advised to use something
 like Lwt or Async, that are far more comprehensive.
-This module depends on {!CCGen}.
-
-@since 0.6
 
 {b NOTE} this was formerly a monadic IO module. The old module is now
 in [containers.advanced] under the name [CCMonadIO].
@@ -57,8 +54,12 @@ Examples:
     )
 ) ;;
 ]}
+
+@since 0.6
+
 *)
 
+
 type 'a gen = unit -> 'a option  (** See {!CCGen} *)
 
 (** {2 Input} *)
diff --git a/core/CCString.mli b/core/CCString.mli
index 8945e525..5012d517 100644
--- a/core/CCString.mli
+++ b/core/CCString.mli
@@ -25,6 +25,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *)
 
 (** {1 Basic String Utils}
+
 Consider using {!Containers_string.KMP} for pattern search, or Regex
 libraries. *)
 
diff --git a/doc/intro.txt b/doc/intro.txt
index e69de29b..0b2dbe43 100644
--- a/doc/intro.txt
+++ b/doc/intro.txt
@@ -0,0 +1,115 @@
+{1 Containers}
+
+{2 Change Log}
+
+See {{: https://github.com/c-cube/ocaml-containers/blob/master/CHANGELOG.md } this file}
+
+{2 License}
+
+This code is free, under the BSD license.
+
+The logo (media/logo.png) is
+CC-SA3 {{:http://en.wikipedia.org/wiki/File:Hypercube.svg} wikimedia}
+
+{2 Contents}
+
+The design is mostly centered around polymorphism rather than functors. Such
+structures comprise (some modules in misc/, some other in core/):
+
+the core library, containers, now depends on
+{{:https://github.com/mjambon/cppo}cppo} and base-bytes (provided
+by ocamlfind).
+
+{4 Core Modules (extension of the standard library)}
+
+{!modules:
+CCArray
+CCBool
+CCError
+CCFloat
+CCFun
+CCHash
+CCHeap
+CCInt
+CCList
+CCOpt
+CCOrd
+CCPair
+CCPrint
+CCRandom
+CCString
+CCVector
+}
+
+{4 Containers.data}
+
+{!modules:
+CCBV
+CCCache
+CCFQueue
+CCFlatHashtbl
+CCMultiMap
+CCMultiSet
+CCPersistentHashtbl
+CCTrie
+}
+
+{4 Containers.io}
+
+{!modules: CCIO}
+
+{4 Containers.sexp}
+
+A small S-expression library.
+
+{!modules: CCSexp}
+
+{4 Containers.iter}
+
+Iterators:
+
+{!modules: CCKList CCKTree}
+
+{4 S-expressions}
+
+{!modules: CCSexp}
+
+{4 String}
+
+{!modules: Levenshtein KMP}
+
+{4 Advanced}
+
+{!modules: CCLinq CCCat CCBatch}
+
+{4 Misc}
+
+This list is not necessarily up-to-date.
+
+{!modules:
+AbsSet
+Bij
+FlatHashtbl
+Hashset
+Heap
+Heap
+LazyGraph
+Mixtbl
+PHashtbl
+PrintBox
+RAL
+SmallSet
+SplayMap
+SplayTree
+UnionFind
+Univ
+}
+
+{4 Others}
+
+{!modules: Future}
+
+
+{2 Index}
+
+{!indexlist}