minor style changes
[ocurl.git] / README.md
blob244cc8f5cf09ccb4a75eff7fc7039f69f8d694c4
1 ocurl - OCaml libcurl bindings
2 ==============================
4 [![Build Status](https://github.com/ygrek/ocurl/actions/workflows/main.yml/badge.svg)](https://github.com/ygrek/ocurl/actions/workflows/main.yml)
5 [![Build Status](https://ci.appveyor.com/api/projects/status/b20uqxaeyarwy2s4/branch/master?svg=true)](https://ci.appveyor.com/project/ygrek/ocurl/branch/master)
7 Homepage: https://ygrek.org/p/ocurl
9 OCaml bindings to libcurl - client-side URL transfer library,
10 supporting HTTP and a multitude of other network protocols.
11 This is a continuation of ocurl project by Lars Nilsson,
12 previously hosted at http://ocurl.sourceforge.net/
14 NB historically project name is `ocurl`, but opam package and ocaml library name is `curl` (there exists transitional dummy `ocurl` opam package for compatibility).
16 Minimum supported libcurl version : 7.28.0
18 Build
19 =====
21   ./configure && make
23 Adding new libcurl symbol
24 =========================
26 * add symbol in configure.ac
27 * autoreconf
28 * make clean
29 * ./configure
30 * edit curl-helper.c and curl.ml*
32 Making release
33 ==============
35 * Check `make gen` with latest libcurl
36 * Update CHANGES.txt
37 * Update version in configure.ac
38 * autoreconf
39 * commit
40 * ./configure && make && make release
42 TODO:
43 use dune-release (Update CHANGES.md: replace the first heading by release number)
45 ----
46  ygrek at autistici dot org