Blame README.md

rpm-build 0f2925
OCaml Extended standard Library - ExtLib.
rpm-build 0f2925
=========================================
rpm-build 0f2925
rpm-build 0f2925
[![Build Status](https://travis-ci.org/ygrek/ocaml-extlib.svg?branch=master)](https://travis-ci.org/ygrek/ocaml-extlib)
rpm-build 0f2925
[![Build status](https://ci.appveyor.com/api/projects/status/6a3t5iq7ljbd25iq?svg=true)](https://ci.appveyor.com/project/ygrek/ocaml-extlib/branch/master)
rpm-build 0f2925
rpm-build 0f2925
```
rpm-build 0f2925
 * This library is free software; you can redistribute it and/or
rpm-build 0f2925
 * modify it under the terms of the GNU Lesser General Public
rpm-build 0f2925
 * License as published by the Free Software Foundation; either
rpm-build 0f2925
 * version 2.1 of the License, or (at your option) any later version,,
rpm-build 0f2925
 * with the special exception on linking described in file LICENSE.
rpm-build 0f2925
 *
rpm-build 0f2925
 * This library is distributed in the hope that it will be useful,
rpm-build 0f2925
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
rpm-build 0f2925
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
rpm-build 0f2925
 * Lesser General Public License for more details.
rpm-build 0f2925
 *
rpm-build 0f2925
 * You should have received a copy of the GNU Lesser General Public
rpm-build 0f2925
 * License along with this library; if not, write to the Free Software
rpm-build 0f2925
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
rpm-build 0f2925
```
rpm-build 0f2925
rpm-build 0f2925
What is ExtLib ?
rpm-build 0f2925
----------------
rpm-build 0f2925
rpm-build 0f2925
ExtLib is a set of additional useful functions and modules for OCaml.
rpm-build 0f2925
rpm-build 0f2925
Project page :
rpm-build 0f2925
  https://github.com/ygrek/ocaml-extlib
rpm-build 0f2925
rpm-build 0f2925
Online API documentation :
rpm-build 0f2925
  http://ygrek.org.ua/p/extlib/doc/
rpm-build 0f2925
rpm-build 0f2925
Dependencies
rpm-build 0f2925
------------
rpm-build 0f2925
rpm-build 0f2925
* `cppo` - enables conditional compilation to ensure compatibility with various OCaml versions
rpm-build 0f2925
* `ocamlfind >= 1.5.1` - provides bytes package
rpm-build 0f2925
rpm-build 0f2925
Installation
rpm-build 0f2925
------------
rpm-build 0f2925
rpm-build 0f2925
Unzip or untar in any directory and run
rpm-build 0f2925
rpm-build 0f2925
  `make minimal=1 build install`
rpm-build 0f2925
rpm-build 0f2925
This will build and install bytecode and native libraries.
rpm-build 0f2925
On bytecode-only architecture run
rpm-build 0f2925
rpm-build 0f2925
  `make minimal=1 all install`
rpm-build 0f2925
rpm-build 0f2925
`minimal=1` will exclude from build several modules (namely `Unzip` `UChar` `UTF8`) potentially
rpm-build 0f2925
conflicting with other well established OCaml libraries. If your code is expecting to find
rpm-build 0f2925
these modules in extlib - omit this parameter during build to produce the full library.
rpm-build 0f2925
rpm-build 0f2925
Usage
rpm-build 0f2925
-----
rpm-build 0f2925
rpm-build 0f2925
Generate and read the documentation.
rpm-build 0f2925
rpm-build 0f2925
Release
rpm-build 0f2925
-------
rpm-build 0f2925
rpm-build 0f2925
* Review `git log` and update CHANGES
rpm-build 0f2925
* Update version in Makefile
rpm-build 0f2925
* Commit
rpm-build 0f2925
* `make release`
rpm-build 0f2925
* upload tarball and make release on github
rpm-build 0f2925
* opam publish
rpm-build 0f2925
rpm-build 0f2925
Contributors
rpm-build 0f2925
------------
rpm-build 0f2925
rpm-build 0f2925
* Nicolas Cannasse <ncannasse@motion-twin.com>
rpm-build 0f2925
* Brian Hurt <brian.hurt@qlogic.com>
rpm-build 0f2925
* Yamagata Yoriyuki <yori@users.sourceforge.net>
rpm-build 0f2925
* Markus Mottl <markus.mottl@gmail.com>
rpm-build 0f2925
* Jesse Guardiani <jesse@wingnet.net>
rpm-build 0f2925
* John Skaller <skaller@users.sourceforge.net>
rpm-build 0f2925
* Bardur Arantsson <bardur@scientician.net>
rpm-build 0f2925
* Janne Hellsten <jjhellst@gmail.com>
rpm-build 0f2925
* Richard W.M. Jones <rjones@redhat.com>
rpm-build 0f2925
* ygrek <ygrek@autistici.org>
rpm-build 0f2925
* Gabriel Scherer <gabriel.scherer@gmail.com>
rpm-build 0f2925
* Pietro Abate <pietro.abate@pps.jussieu.fr>
rpm-build 0f2925
rpm-build 0f2925
License
rpm-build 0f2925
-------
rpm-build 0f2925
rpm-build 0f2925
See LICENSE