huxpro / book Goto Github PK

This is the source code for the Real World OCaml 2nd edition, which is still a work in progress. The original edition was written by Yaron Minsky, Anil Madhavapeddy and Jason Hickey, and the revised edition is being lead by Yaron Minsky and Anil Madhavapeddy. There have been significant contributions to the revised tooling from Ashish Agarwal, Jeremy Yallop, Frederic Bour, and Sander Spies.

An online snapshot of the development book is available from https://dev.realworldocaml.org. There is a Feedback pane on each chapter which leads to a dedicated section on the OCaml discussion forum where you can register broader feedback. More specific issues such as typos can be reported on the issue tracker.

The book is structured as HTML sources that are transformed into the online site via OCaml scripts. Code fragments are evaluated and inserted into the book via custom <link> tags in the source code.

If you wish to build the book yourself, then you will need to be familiar with the opam pinning workflow.

There are three main repositories for the book:

• https://github.com/realworldocaml/scripts contains the rwo opam package which provides the binaries for build and dependency analysis of the book sources. These scripts are currently unreleased and so need to be pinned to master via opam. The working branch is currently the v2 branch.
• https://github.com/realworldocaml/examples contain the source code fragments which are evaluated and inserted into this book. They can be checked out separately for easy building by readers. The code fragments are evaluted by the rwo tool by using the ocaml-topexpect toplevel parser. The working branch is currently the v2 branch.
• https://github.com/realworldocaml/book is this repository, whic uses the scripts and examples repositories to compile the HTML site online.

All of the code and examples are built using OCaml 4.06.1.

Here are the commands to build the website:

To install the dependencies needed for the book and the code examples:

opam pin add rwo . -n
opam install rwo --deps-only

The contents of the pages is split between:

• the chapter contents, written using pandoc markdown.
• the code examples

To generate the HTML pages:

make

The HTML pages are created in _build/default/static/. Open _build/default/static/index.html to start browsing the freshly built version of the book.

It is possible to automatically test that the the code examples files work fine. To check that shell scripts and .ml files do what they are expected:

make test

This will run all the tests in "determinitic mode", which is suitable for the CI and it will display the diff between what is expected and what is produced.

To accept the changes:

make promote

A few code examples are not deterministic: for instance benchmarks. In this case, there is a special command to run:

make test-all

To accept the changes:

make promote