[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] scratch/rfc-mode dc1a3a978f 02/52: improve the readme
From: |
Stefan Monnier |
Subject: |
[nongnu] scratch/rfc-mode dc1a3a978f 02/52: improve the readme |
Date: |
Wed, 12 Oct 2022 16:29:18 -0400 (EDT) |
branch: scratch/rfc-mode
commit dc1a3a978f98e0142c2ebe7d866b0a4bb8538e74
Author: Nicolas Martyanoff <khaelin@gmail.com>
Commit: Nicolas Martyanoff <khaelin@gmail.com>
improve the readme
---
README.md | 19 ++++++++++++++++---
1 file changed, 16 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index e485ec1ed1..6d3e24d29a 100644
--- a/README.md
+++ b/README.md
@@ -7,20 +7,33 @@ The rfc-mode Emacs major mode is a browser and reader for RFC
documents.
## Installation
-The package should be installed from MELPA. After that, just load rfc-mode:
+The package should be installed from MELPA.
+
+Start by loading the mode:
```elisp
(require 'rfc-mode)
```
+Then set the location containing all RFC documents (the default value is the
+`rfc` directory in the home directory):
+
+```elisp
+(setq rfc-mode-directory (expand-file-name "~/rfc/"))
+```
+
+The entire RFC collection can be download from
+https://www.rfc-editor.org/retrieve/bulk.
+
Call `rfc-mode-browse` to choose a RFC document to read, or `rfc-mode-read` to
enter the reference of the RFC document yourself.
## Screenshots
+### Browser
+![Helm-based browser](img/helm-browser.png)
+### Reader
![Reader](img/reader.png)
-![Helm-based browser](img/helm-browser.png)
-
## Contact
If you have an idea or a question, email me at <khaelin@gmail.com>.
- [nongnu] branch scratch/rfc-mode created (now a734721104), Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode 5bda3310af 17/52: remove useless groups for custom variables, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode 91bf9ff561 34/52: Avoid rfc-mode-read replacing the current buffer, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode b651eac96c 09/52: add repository link to group, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode 1ae16d2fb8 35/52: Implement a command to navigate to existing sections, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode ff1e3251e9 01/52: initial import, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode dc1a3a978f 02/52: improve the readme,
Stefan Monnier <=
- [nongnu] scratch/rfc-mode 3719b9ce9f 20/52: derive rfc-mode from text-mode, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode 821a039ae6 18/52: autoload rfc-mode-read, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode 355f25ee2a 31/52: Add commands to move to the previous/next RFC section, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode a3a58e9883 15/52: better section title detection, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode 55c0c24f9b 28/52: Make rfc-mode inherit from special-mode, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode e037a7ce5c 33/52: Add Tab and S-Tab to navigate through RFC button links, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode 02d8dfeb70 16/52: do not fail if helm is not available, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode 7819cb64b9 25/52: add a changelog, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode e2608adbac 36/52: Make hyperlinks clickable with the mouse too, Stefan Monnier, 2022/10/12
- [nongnu] scratch/rfc-mode 390659e19c 10/52: automatically download indices and documents if they don't exist, Stefan Monnier, 2022/10/12