ocaml: mention ocaml flycheck/merlin configuration in README
This commit is contained in:
parent
2be4dd2795
commit
bd77db5d84
|
@ -7,6 +7,7 @@
|
||||||
- [[#features][Features:]]
|
- [[#features][Features:]]
|
||||||
- [[#install][Install]]
|
- [[#install][Install]]
|
||||||
- [[#layer][Layer]]
|
- [[#layer][Layer]]
|
||||||
|
- [[#using-merlin-for-error-reporting][Using merlin for error reporting]]
|
||||||
- [[#opam-packages][OPAM packages]]
|
- [[#opam-packages][OPAM packages]]
|
||||||
- [[#key-bindings][Key Bindings]]
|
- [[#key-bindings][Key Bindings]]
|
||||||
- [[#repl-utop][REPL (utop)]]
|
- [[#repl-utop][REPL (utop)]]
|
||||||
|
@ -22,7 +23,7 @@ This is a very basic layer for editing ocaml files.
|
||||||
- Syntax highlighting (major-mode) via [[https://github.com/ocaml/tuareg][tuareg-mode]]
|
- Syntax highlighting (major-mode) via [[https://github.com/ocaml/tuareg][tuareg-mode]]
|
||||||
- Error reporting, completion and type display via [[https://github.com/ocaml/merlin][merlin]]
|
- Error reporting, completion and type display via [[https://github.com/ocaml/merlin][merlin]]
|
||||||
- auto-completion with company mode via [[https://github.com/ocaml/merlin][merlin]]
|
- auto-completion with company mode via [[https://github.com/ocaml/merlin][merlin]]
|
||||||
- syntax-checking via [[https://github.com/diml/utop][flycheck-ocaml]]
|
- syntax-checking via [[https://github.com/flycheck/flycheck-ocaml][flycheck-ocaml]] (or alternatively [[https://github.com/ocaml/merlin][merlin]])
|
||||||
|
|
||||||
* Install
|
* Install
|
||||||
** Layer
|
** Layer
|
||||||
|
@ -30,6 +31,16 @@ To use this configuration layer, add it to your =~/.spacemacs=. You will need to
|
||||||
add =ocaml= to the existing =dotspacemacs-configuration-layers= list in this
|
add =ocaml= to the existing =dotspacemacs-configuration-layers= list in this
|
||||||
file.
|
file.
|
||||||
|
|
||||||
|
** Using merlin for error reporting
|
||||||
|
By default [[https://github.com/flycheck/flycheck-ocaml][flycheck-ocaml]] is used for error reporting when the
|
||||||
|
=syntax-checking= layer is also enabled as this is common throughout spacemacs.
|
||||||
|
You can disable this and switch back to [[https://github.com/ocaml/merlin][merlin]]'s default error reporting method
|
||||||
|
by adding [[https://github.com/flycheck/flycheck-ocaml][flycheck-ocaml]] to your excluded packages list in =.spacemacs=:
|
||||||
|
|
||||||
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
dotspacemacs-excluded-packages '(... flycheck-ocaml ... )
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
** OPAM packages
|
** OPAM packages
|
||||||
This layer requires some [[http://opam.ocaml.org][opam]] packages:
|
This layer requires some [[http://opam.ocaml.org][opam]] packages:
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue