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

[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>.



reply via email to

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