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||2 months ago|
|book||2 weeks ago|
|duniverse||1 month ago|
|scripts||1 year ago|
|static||3 months ago|
|.dockerignore||2 years ago|
|.gitattributes||1 year ago|
|.gitignore||1 year ago|
|.hgignore||2 years ago|
|.travis.yml||1 year ago|
|Dockerfile||2 months ago|
|LICENSE.md||5 months ago|
|Makefile||2 weeks ago|
|NOTES.md||2 years ago|
|README.md||1 month ago|
|dune-get||2 weeks ago|
|dune-project||6 months ago|
|rwo.opam||2 months ago|
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.
Each chapter of the book sits in a separate subfolder of 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.
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.
Here are the commands to build the website:
You can install system dependencies by running:
All OCaml dependencies are vendored in the
duniverse/ directory except
dune build system itself. It's preferable to use an empty opam switch
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
To generate the HTML pages:
The HTML pages are created in
_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
.ml files do what they are expected:
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:
A few code examples are not deterministic: for instance benchmarks. In this case, there is a special command to run:
To accept the changes:
RWO's dependencies are vendored using
duniverse. If you want to upgrade them
to their latest availbale opam version you can run:
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
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>