Skip to content

Commit

Permalink
chore: remove ocamlbuild from README (#1045)
Browse files Browse the repository at this point in the history
it'it's unnecessary because nobody uses ocamlbuild

Signed-off-by: Rudi Grinberg <[email protected]>
  • Loading branch information
rgrinberg authored Jun 30, 2024
1 parent d457c34 commit df5f3b1
Showing 1 changed file with 0 additions and 29 deletions.
29 changes: 0 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,13 @@ You can find help from cohttp users and maintainers at the

- [Installation](#installation)
- [Client Tutorial](#client-tutorial)
* [Compile and execute with ocamlbuild](#compile-and-execute-with-ocamlbuild)
* [Compile and execute with dune](#compile-and-execute-with-dune)
- [Dealing with timeouts](#dealing-with-timeouts)
- [Managing sessions](#managing-sessions)
- [Multipart form data](#multipart-form-data)
- [Creating custom resolver: a Docker Socket Client example](#creating-custom-resolver--a-docker-socket-client-example)
- [Dealing with redirects](#dealing-with-redirects)
- [Basic Server Tutorial](#basic-server-tutorial)
* [Compile and execute with ocamlbuild](#compile-and-execute-with-ocamlbuild-1)
* [Compile and execute with dune](#compile-and-execute-with-dune-1)
- [Installed Binaries](#installed-binaries)
- [Debugging](#debugging)
Expand Down Expand Up @@ -120,25 +118,6 @@ Consult the following modules for reference:
The full documentation for the latest published version of the library is
available on the [repository github pages](https://mirage.github.io/ocaml-cohttp/).

### Compile and execute with ocamlbuild

Build and execute with:

```
$ ocamlbuild -use-ocamlfind -tag thread -pkg cohttp-lwt-unix client_example.native
$ ./client_example.native
```

For manual builds, it is usually enough to remember that cohttp ships with 6
findlib (`ocamlfind`) libraries:

* `cohttp` - Base `Cohttp` module. No platform specific functionality
* `cohttp-async` - Async backend `Cohttp_async`
* `cohttp-lwt` - Lwt backend without unix specifics
* `cohttp-lwt-unix` - Unix based lwt backend
* `cohttp-lwt-jsoo` - Jsoo (XHR) client
* `cohttp-top` - Print cohttp types in the toplevel (`#require "cohttp-top"`)

### Compile and execute with dune

Create this `dune` file
Expand Down Expand Up @@ -401,14 +380,6 @@ let server =
let () = ignore (Lwt_main.run server)
```

### Compile and execute with ocamlbuild

Build and execute with:
```
$ ocamlbuild -use-ocamlfind -tag thread -pkg cohttp-lwt-unix server_example.native
$ ./server_example.native
```

### Compile and execute with dune

Create this `dune` file
Expand Down

0 comments on commit df5f3b1

Please sign in to comment.