https://github.com/gmmorris/theocamlsystem4.06inreason
A copy of the TheOCamlsystem4.06 with all code examples in ReasonML
https://github.com/gmmorris/theocamlsystem4.06inreason
Last synced: 3 months ago
JSON representation
A copy of the TheOCamlsystem4.06 with all code examples in ReasonML
- Host: GitHub
- URL: https://github.com/gmmorris/theocamlsystem4.06inreason
- Owner: gmmorris
- Created: 2018-06-09T18:44:08.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-09T19:43:29.000Z (almost 7 years ago)
- Last Synced: 2024-12-31T23:12:41.923Z (4 months ago)
- Language: HTML
- Homepage: http://gidi.io/TheOCamlsystem4.06InReason/index.html
- Size: 1.3 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
The OCaml system release 4.06 in ReasonML
===============================
A clone of the original OCaml system manual written by __Xavier Leroy__, __Damien Doligez__, __Alain Frisch__, __Jacques Garrigue__, __Didier Rémy__ and __Jérôme Vouillon__ with all code examples written in ReasonML instead of OCaml.
All original rights their and I am simply trying to make the docs more accesible to the ReasonML community.
The original OCaml docs are on [caml.inria.fr ](https://caml.inria.fr/pub/docs/manual-ocaml/index.html)
# Where
You can view the docs online here: __[gmmorris.github.io/TheOCamlsystem4.06InReason](http://gidi.io/TheOCamlsystem4.06InReason/index.html)__
# Why
I have been trying to learn ReasonML and in order to understand the ecosystem properly I felt I should understand OCaml and so I have been referring to the OCaml manual quite alot.
The one annoyance I have had is that going back and forth converting the OCaml code to ReasonML code has been a little annoying and the Chrome extension didn't seem to do well on these pages.
To rectify this I wrote a small script which creates a copy of the docs and converts all the code snippets inside of it.
# How can I contribute?
If you find a section of the code hasn't been converted properly (which is likely as this has been done programmatically) please do correct it and and issue a PR.
Please __do not__ change the _docs/_ folder but rather make the correction in the _./convertToReason/index.js_ script or the _./TheOCamlsystem4.06/_ documentation, and then regenerate the docs folder by running:
```bash
cd ./convertToReason
npm i
node ./index.js
```
This will rebuild the docs and allow you to commit and make a Pull Request. :)