jt/emacs-prelude
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Improve ocaml module documentation

Browse source 
Add some documentation about environment assumptions, and correct some
grammar issues.
This commit is contained in:
Geoff Shannon 2014-10-24 14:30:22 -04:00
parent 3d85f4014c
commit 350504521a
1 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
modules/prelude-ocaml.el
View file

@ -13,6 +13,23 @@
;; tuareg is the preferred ocaml mode for Emacs ;; tuareg is the preferred ocaml mode for Emacs
;; These setups for ocaml assume that you are using the OPAM package
;; manager (http://opam.ocaml.org/).
;; Because of the apparent complexity of getting emacs environment
;; variables setup to use opam correctly, it is instead easier to use
;; opam itself to execute any necessary commands.
;; Also, the standard OCaml toplevel usage has been replaced in favor
;; of UTOP, the universal toplevel, and we assume that you are using
;; the Jane Street Core libraries rather than the regular OCaml
;; standard libraries
;; The minimum required setup for using Prelude's OCaml setup would be
;; to install OPAM, and then, minimally `opam install core utop'. A
;; good getting started guide is available at
;; https://github.com/realworldocaml/book/wiki/Installation-Instructions
;;; License: ;;; License:
;; This program is free software; you can redistribute it and/or ;; This program is free software; you can redistribute it and/or
@ -56,7 +73,7 @@
;; Setup merlin completions company is used by default in prelude ;; Setup merlin completions company is used by default in prelude
(add-to-list 'company-backends 'merlin-company-backend) (add-to-list 'company-backends 'merlin-company-backend)
;; But merlin also offers support for autocomplete, uncomment this next line ;; Merlin also offers support for autocomplete, uncomment this next line
;; to activate it. ;; to activate it.
;; (setq merlin-use-auto-complete-mode t) ;; (setq merlin-use-auto-complete-mode t)