aboutsummaryrefslogtreecommitdiff
path: root/doc/plugin_tutorial/README.md
diff options
context:
space:
mode:
authorTalia Ringer2019-11-25 10:17:23 -0800
committerTalia Ringer2019-11-25 14:59:49 -0800
commit71e30859b9534c3b55645e94f2d542f18b6e5901 (patch)
tree683022f050160e9b9bac7da8dac9ed5adb666daf /doc/plugin_tutorial/README.md
parent0e9cd0fe99216bc09a09a0da6906f9501b682223 (diff)
Add more development setup instructions for tutorials
Diffstat (limited to 'doc/plugin_tutorial/README.md')
-rw-r--r--doc/plugin_tutorial/README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/plugin_tutorial/README.md b/doc/plugin_tutorial/README.md
index 6d142a9af8..e0cedb0487 100644
--- a/doc/plugin_tutorial/README.md
+++ b/doc/plugin_tutorial/README.md
@@ -3,13 +3,21 @@ How to write plugins in Coq
# Working environment
In addition to installing OCaml and Coq, it can help to install several tools for development.
-
- ## Merlin
+
+ ## Tuareg and Merlin
These instructions use [OPAM](http://opam.ocaml.org/doc/Install.html)
```shell
opam install merlin # prints instructions for vim and emacs
+opam install tuareg # syntax highlighting for OCaml
+opam user-setup install # automatically configures editors for merlin
+```
+
+ Adding this line to your .emacs helps Tuareg recognize the .mlg extension:
+
+```shell
+(add-to-list 'auto-mode-alist '("\\.mlg$" . tuareg-mode) t)
```
## This tutorial
@@ -23,7 +31,7 @@ make # build
# tuto0 : basics of project organization
- package a ml4 file in a plugin, organize a `Makefile`, `_CoqProject`
+ package an mlg file in a plugin, organize a `Makefile`, `_CoqProject`
- Example of syntax to add a new toplevel command
- Example of function call to print a simple message
- Example of function call to print a simple warning