[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/devil 8f466e1ab4: Add sections: Get Started, Thanks
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/devil 8f466e1ab4: Add sections: Get Started, Thanks |
Date: |
Mon, 22 May 2023 14:00:17 -0400 (EDT) |
branch: elpa/devil
commit 8f466e1ab4976b4878ff9dd31d7f9366850e819b
Author: Susam Pal <susam@susam.net>
Commit: Susam Pal <susam@susam.net>
Add sections: Get Started, Thanks
---
CHANGES.org | 4 ++--
README.org | 33 +++++++++++++++++++++++++++++++--
2 files changed, 33 insertions(+), 4 deletions(-)
diff --git a/CHANGES.org b/CHANGES.org
index c3b3484d52..22b0517703 100644
--- a/CHANGES.org
+++ b/CHANGES.org
@@ -57,8 +57,8 @@
- Make the function =dev--tests= non-interactive.
- Translation issue that caused invalid Emacs key sequences on mapping
=-=. For example, mapping =-= to =C-x= and typing =- C-f= produced
- =C-x CC-xf=. This has been fixed so that =- C-f= is now translated to
- =C-x C-f=.
+ =C-x CC-xf=. This has been fixed so that =- C-f= is now translated
+ to =C-x C-f=.
** 0.1.0 (2023-05-07)
diff --git a/README.org b/README.org
index 07a42234c9..b67089d49b 100644
--- a/README.org
+++ b/README.org
@@ -16,7 +16,27 @@ if you can charm the Devil! But beware, for in this
sinister domain,
you must relinquish your comma key and embrace an editing experience
that whispers wicked secrets into your fingertips!
-Read the [[https://susam.github.io/devil/][manual]] for more details on how to
use Devil.
+** Get Started
+:PROPERTIES:
+:CUSTOM_ID: get-started
+:END:
+
+By default, Devil mode rebinds the comma key to activate Devil. Once
+activated, Devil reads a so-called Devil key sequence from you. As you
+type your Devil key sequence, Emacs translates the key sequence to a
+regular Emacs key sequence. If any command is bound to the translated
+Emacs key sequence, Devil runs that command and then deactivates
+itself.
+
+By default, each comma in the Devil key sequence is translated to
+"C-". For example, if you type ", x , f", Devil translates it to "C-x
+C-f". Similarly, "m" is translated to "M-", so if you type ", m s",
+Devil translates it to "C-M-s". There are several other translations
+available in the default translation rules that let you enjoy working
+with Emacs while avoiding modifier keys. Further, the Devil activation
+key, translation rules, etc. are customisable.
+
+Read the [[https://susam.github.io/devil/][manual]] to learn how to install,
use, and customise Devil.
** Channels
:PROPERTIES:
@@ -33,12 +53,21 @@ You are welcome to subscribe to, follow, or join one or
more of the
above channels to receive updates from the author or ask questions
about this project.
-* Support
+** Support
:PROPERTIES:
:CUSTOM_ID: support
:END:
To report bugs, suggest improvements, or ask questions,
[[https://github.com/susam/devil/issues][create issues]].
+** Thanks
+:PROPERTIES:
+:CUSTOM_ID: thanks
+:END:
+Thanks to:
+
+- [[https://github.com/riscy][Chris Rayner]] for initial code review.
+- [[https://github.com/phikal][Philip Kaludercic]] for initial code review and
patches.
+
** More
:PROPERTIES:
:CUSTOM_ID: more
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [nongnu] elpa/devil 8f466e1ab4: Add sections: Get Started, Thanks,
ELPA Syncer <=