V2 of Real World OCaml https://dev.realworldocaml.org

Yaron Minsky 30d8c11b72 Merge pull request #3274 from NathanReb/update-duniverse-config 1 day ago
bin aa60e73b66 port the html generation scripts to v0.13 2 months ago
book a60af032d2 Merge pull request #3263 from realworldocaml/yminsky-typo-fix 2 weeks ago
duniverse eda0bc717d Upgrade duniverse 1 month ago
scripts 62cb5053b8 update to opam2 files and Dockerfiles 1 year ago
static e3c44e6203 Add PDF generation in rwo-build 3 months ago
.dockerignore 539f4051ae port to a monorepo 2 years ago
.gitattributes a992ae296a Add a .gitattributes file 1 year ago
.gitignore 62cb5053b8 update to opam2 files and Dockerfiles 1 year ago
.hgignore ff8a30398e added hgignore, so I can use hg-git properly 2 years ago
.travis.yml c1e2b58573 Use upstream travis-ci tool to fix deployment issue 1 year ago
Dockerfile bcc164581f upgrade to dune 2.0.1 2 months ago
LICENSE.md 0f3e970817 add LICENSE for the various uses in this repo 5 months ago
Makefile 462ea0033d Update Makefile and dune-get for latest duniverse 2 weeks ago
NOTES.md 9a60873794 Rename .topscript files into .mlt 2 years ago
README.md 1e6dd9cdaa Bump dune version in README.md 1 month ago
dune-get 462ea0033d Update Makefile and dune-get for latest duniverse 2 weeks ago
dune-project 1bf802fce7 Set up RWO's duniverse 6 months ago
rwo.opam 39f8ab9372 update to 4.09.0 2 months ago

README.md

Real World OCaml v2

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.

Repository layout

Each chapter of the book sits in a separate subfolder of the book/ directory. The README.md file contains the text of the chapter, written in markdown. Each ocaml or shell code block in the chapter is validated using mdx. The more complex and structured examples live in an examples/ sub folder and mdx is used to keep the examples and the chapter's code block in sync.

The bin/ folder contains the OCaml scripts used to generate the books HTML and PDF versions.

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

Building

Here are the commands to build the website:

Installing Dependencies

You can install system dependencies by running:

make depext

All OCaml dependencies are vendored in the duniverse/ directory except for the dune build system itself. It's preferable to use an empty opam switch with only dune installed to avoid conflicts between the opam and local libraries. To set up your RWO development environment you can run:

opam switch create rwo 4.09.0
opam install dune=2.0.1

Generating the HTML

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.

Testing the code examples

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

Testing non-deterministic examples

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

Upgrading or adding dependencies

RWO's dependencies are vendored using duniverse. If you want to upgrade them to their latest availbale opam version you can run:

make duniverse-upgrade

Additionally, if you're working on the book and need a new package vendored, you can simply add it to the $DEPS variable in the Makefile and run the above command again.

It's possible that after upgrading you get some errors because vendored dependencies use jbuild files instead of dune files and compatibility with those has been dropped in dune 2. You can upgrade those using the following command:

dune upgrade --root duniverse/<package_name>.<version>