[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] externals/caml 466d703 194/197: Minor improvements to the READM
From: |
Stefan Monnier |
Subject: |
[nongnu] externals/caml 466d703 194/197: Minor improvements to the README |
Date: |
Sat, 21 Nov 2020 01:20:05 -0500 (EST) |
branch: externals/caml
commit 466d703dca1308b8888641f504eedd1bd761c529
Author: Christophe Troestler <Christophe.Troestler@umons.ac.be>
Commit: Christophe Troestler <Christophe.Troestler@umons.ac.be>
Minor improvements to the README
---
README.md | 25 +++++++++++++++++--------
1 file changed, 17 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 6135c1d..e0b5a33 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@ OCaml Emacs mode
================
The files in this archive define a `caml-mode` for Emacs, for editing
-OCaml programs, as well as an inferior-caml-mode, to run a toplevel.
+[OCaml][] programs, as well as an inferior-caml-mode, to run a toplevel.
Caml-mode supports indentation, compilation and error retrieving,
sending phrases to the toplevel. Moreover support for hilit,
@@ -10,10 +10,14 @@ font-lock and imenu was added.
This package is based on the original `caml-mode` for caml-light by
Xavier Leroy, extended with indentation by Ian Zimmerman. For details
-see README.itz, which is the README from Ian Zimmerman's package.
+see [README.itz](README.itz), which is the README from Ian Zimmerman's
+package.
-To use it, just put the .el files in your emacs load path, and add the
-following lines in your .emacs.
+Installation
+------------
+
+To use it, just put the .el files in your Emacs load path, and add the
+following lines in your [Init File][].
(add-to-list 'auto-mode-alist '("\\.ml[iylp]?$" . caml-mode))
(autoload 'caml-mode "caml" "Major mode for editing OCaml code." t)
@@ -35,9 +39,9 @@ To install ocamltags, do
% make install-ocamltags
-To use highlighting capabilities, add ONE of the following two lines
-to your .emacs. The second one works better on recent versions of
-emacs.
+To use highlighting capabilities, add **one** of the following two lines
+to your [Init File][]. The second one works better on recent versions of
+Emacs.
(if window-system (require 'caml-hilit))
(if window-system (require 'caml-font))
@@ -65,7 +69,7 @@ Once you have started caml by M-x run-caml:
For other bindings, see <kbd>C-h b</kbd>.
-Some remarks about the style supported:
+Some remarks about the style supported
--------------------------------------
Since OCaml's syntax is very liberal (more than 100
@@ -94,3 +98,8 @@ stops, to speed up the code. A phrase starts when any of the
keywords
`external`, appears at the beginning of a line. Using the first column
for such keywords in other cases may confuse the phrase selection
function.
+
+
+[OCaml]: http://ocaml.org/
+[MELPA]: https://melpa.org/
+[Init File]:
https://www.gnu.org/software/emacs/manual/html_node/emacs/Init-File.html
- [nongnu] externals/caml f49a296 164/197: caml-types.el: Extract the feedback logic to a separate function., (continued)
- [nongnu] externals/caml f49a296 164/197: caml-types.el: Extract the feedback logic to a separate function., Stefan Monnier, 2020/11/21
- [nongnu] externals/caml 4c414a0 180/197: Emacs: Improve colors on dark themes, Stefan Monnier, 2020/11/21
- [nongnu] externals/caml 07d301a 174/197: elisp: fixed grammar in docstrings and comments, Stefan Monnier, 2020/11/21
- [nongnu] externals/caml 2964c4d 162/197: Add another format to parse compiler output., Stefan Monnier, 2020/11/21
- [nongnu] externals/caml 02f8809 184/197: Emacs: use symbol boundaries in regular expressions, Stefan Monnier, 2020/11/21
- [nongnu] externals/caml 4c8c8d3 176/197: makefiles: use 'install' instead of 'cp' in 'make install' targets, Stefan Monnier, 2020/11/21
- [nongnu] externals/caml c9e7f57 186/197: Fix most CheckDoc errors., Stefan Monnier, 2020/11/21
- [nongnu] externals/caml 78ec6be 185/197: Transform the README to Markdown, Stefan Monnier, 2020/11/21
- [nongnu] externals/caml 333d2f4 191/197: Improve syntax highlighting, Stefan Monnier, 2020/11/21
- [nongnu] externals/caml adafe8a 190/197: Add OPAM file, Stefan Monnier, 2020/11/21
- [nongnu] externals/caml 466d703 194/197: Minor improvements to the README,
Stefan Monnier <=
- [nongnu] externals/caml 1d6cd46 196/197: Add make target for opam release, Stefan Monnier, 2020/11/21
- [nongnu] externals/caml 38ebde1 197/197: Generate a caml-mode-site-file, Stefan Monnier, 2020/11/21
- [nongnu] externals/caml 29aaf70 193/197: Move the changelog to CHANGES, Stefan Monnier, 2020/11/21
- [nongnu] externals/caml bfa612b 195/197: Mention easy ways of installing this package, Stefan Monnier, 2020/11/21
- [nongnu] externals/caml b6eebe4 192/197: Apply some recommendations of checkdoc, Stefan Monnier, 2020/11/21
- [nongnu] externals/caml 9d5dbfb 131/197: - Replaced setq by add-to-list in README, Stefan Monnier, 2020/11/21