docs(README.md): Add developer-docs section

pfitaxel · Aug 20, 2021 · f87bd25 · f87bd25
1 parent d62a89a
commit f87bd25
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -102,6 +102,17 @@ opening **.ml** buffers using `tuareg-mode` and the following
 Bug reports and suggestions are very welcome: feel free to open a new
 [issue](https://github.com/pfitaxel/learn-ocaml.el/issues/new) or PR.
 
+## Developer docs
+
+* **Setup the `learn-ocaml.el` dev environment** by following these refs:
+  * [GH: erikmd/tapfa-init.el](https://github.com/erikmd/tapfa-init.el) (opam (2.x) + OCaml (≥ 4.05.0) + GNU Emacs (≥ 25.1) + Tuareg + Merlin)
+  * [git-scm.com/download](https://git-scm.com/download) (Git)
+  * [Gist: Magit](https://gist.github.com/erikmd/82c4b2a50a77c98e8fe6318530c531b7) (Magit)
+  * [Gist: Resources for elisp dev](https://gist.github.com/erikmd/35251ac083e7433f3e780f7eb8856782) (which-key + helpful + edebug-x + Tutorials)
+  * [GH: erikmd/docker-examples](https://github.com/erikmd/docker-examples#prérequis--installer-docker-et-docker-compose) (Docker)
+* **Use the Makefile to start the test environment**:  
+  run `make help` to list the available Makefile commands.
+
 ## Authors and Acknowledgments
 
 **learn-ocaml.el** has been developed in University Toulouse III by