emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/opam-switch-mode 22fa9efcb6 27/31: docs(README.md): Add in


From: ELPA Syncer
Subject: [nongnu] elpa/opam-switch-mode 22fa9efcb6 27/31: docs(README.md): Add install section
Date: Mon, 14 Nov 2022 09:00:01 -0500 (EST)

branch: elpa/opam-switch-mode
commit 22fa9efcb65ca552582af9f1b5566c553eafa633
Author: Erik Martin-Dorel <erik.martin-dorel@irit.fr>
Commit: Erik Martin-Dorel <erik.martin-dorel@irit.fr>

    docs(README.md): Add install section
---
 README.md | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 0b075fe9a7..1dac4171fe 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,22 @@ switches that are known at that time. If you create a new 
switch, re-enable
 the minor mode to get it added to the menu. The menu contains an additional
 entry "reset" to reset the environment to the state when emacs was started.
 
+## Installing `opam-switch-mode`
+
+The recommended way to install the mode relies on the
+[MELPA](https://melpa.org/) repository of Emacs packages, and the
+[`use-package`](https://github.com/jwiegley/use-package) macro.
+Assuming you have already set up those in your `.emacs`, just write:
+
+```elisp
+(use-package opam-switch-mode
+  :ensure t
+  :hook
+  (coq-mode . opam-switch-mode))
+```
+
+so that the minor mode is automatically enabled when `coq-mode` is on,
+see also [`opam-switch-mode` aware modes](#opam-switch-mode-aware-modes).
 
 ## Command `opam-switch-set-switch`
 
@@ -36,8 +52,8 @@ that depend on the currently active opam switch.
 For obvious reasons, `opam-switch-set-switch` will only affect emacs and not
 any other shells outside emacs.
 
-## opam-switch-mode aware modes
+## `opam-switch-mode` aware modes
 
-- [Proof General](https://proofgeneral.github.io/)
+- `coq-mode` from [`proof-general`](https://proofgeneral.github.io/)
   can kill the coq background process, when the opam switch changes,
   see 
[`coq-kill-coq-on-opam-switch`](https://proofgeneral.github.io/doc/master/userman/Coq-Proof-General/#index-coq_002dkill_002dcoq_002don_002dopam_002dswitch).



reply via email to

[Prev in Thread] Current Thread [Next in Thread]