[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).
- [nongnu] branch elpa/opam-switch-mode created (now a306f75d82), ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode dea35145a3 30/31: Merge pull request #7 from ProofGeneral/add-doc, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 515d08dfb3 09/31: check and handle opam errors, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode cad8510077 18/31: refactor: Run `M-x package-lint-current-buffer` and address its feedback, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 0db601100c 17/31: docs: Run `M-x checkdoc` and address its feedback, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 3d63566b0d 04/31: provide README, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode dd6a86ddad 23/31: Add LICENSE, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 16b8276f85 13/31: use -- for internal stuff, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 5f3d2102ae 26/31: Add OCaml keyword and https://opam.ocaml.org URL, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 7c648a0719 16/31: docs: details (#3), ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 22fa9efcb6 27/31: docs(README.md): Add install section,
ELPA Syncer <=
- [nongnu] elpa/opam-switch-mode f62c708225 14/31: typo fix, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 95a3b4225a 15/31: fix: (opam-switch-mode) × 3 bug (#4), ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode a306f75d82 31/31: docs(README.md): detail, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 7306ce0fee 10/31: add separator in menu after current switch, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode e2ed274519 05/31: add emacs code documentation, also delete default switch parsing, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 7de138a0e9 07/31: add minor mode with menu bar menu, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode e681cbdcb7 29/31: chore: Update header and maintainer mailing list, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode a83de84719 19/31: refactor: Replace `opsw--` with `opam-switch--`, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 8a021ff128 12/31: rename to opam-switch-mode; use opsw as prefix for internals, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode df290bd0e3 21/31: Merge pull request #6 from ProofGeneral/prepare-melpa, ELPA Syncer, 2022/11/14