diff --git a/README.md b/README.md index 3b22f85..22d0a8a 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ This is very bespoke for my requirements, and only something I do/use when I am This library includes the following custom modules: +- Int (exposure of basic integer arithmetic functions) +- Float (exposure of basic float arithmetic functions) - List (functional list data structure) - Queue (functional queue implemented as two lists) - Set (functional set implemented as a red-black tree) @@ -44,4 +46,4 @@ Also take note of the fact that I typically compile everything with `-S` and `-O ## The Core Library -One of the unfortunate consequences of the way OCaml's compilation works, is that there is a library called the core library, documented [here](https://ocaml.org/manual/core.html), which contains some definitions for types and exceptions, yet does not include the code from the stdlib that uses them. When compiling with the `-nopervasives` flag, this is still included but without the standard library. While this makes sense from the perspective of having some fundamental exceptions always available, having types like `list` included makes it very annoying when implemented a custom standard library. This quirk is why my library has no type definition for `list`, `bool`, `option`, etc. but still uses these types. \ No newline at end of file +One of the unfortunate consequences of the way OCaml's compilation works, is that there is a library called the core library, documented [here](https://ocaml.org/manual/core.html), which contains some definitions for types and exceptions, yet does not include the code from the stdlib that uses them. When compiling with the `-nopervasives` flag, this is still included but without the standard library. While this makes sense from the perspective of having some fundamental exceptions always available, having types like `list` included makes it very annoying when implemented a custom standard library. This quirk is why my library has no type definition for `list`, `bool`, `option`, etc. but still uses these types.