branch: externals/setup
commit 912860f508866ac0e6f6961c877d5c99497f5f2e
Author: Philip K <phil...@posteo.net>
Commit: Philip K <phil...@posteo.net>
Update README
---
README.md | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 0a3e45a..0bbb6e7 100644
--- a/README.md
+++ b/README.md
@@ -6,13 +6,13 @@ example, these macros:
(setup shell
(let ((key "C-c s"))
- (global (key shell))
- (bind (key bury-buffer))))
+ (:global (key shell))
+ (:bind (key bury-buffer))))
(setup (package paredit)
- (hide-lighter)
- (hook-into scheme-mode lisp-mode))
+ (:hide-mode)
+ (:hook-into scheme-mode lisp-mode))
will be replaced with the functional equivalent of
@@ -28,8 +28,8 @@ will be replaced with the functional equivalent of
(add-hook 'scheme-mode-hook #'paredit-mode)
(add-hook 'lisp-mode-hook #'paredit-mode)
-Additional "keywords" can be defined using `setup-define'. Invoke
-the command `setup-help' to get a list of macros.
+Additional "keywords" can be defined using `setup-define'. All known
+keywords are documented in the docstring for `setup'.
**Note:** This package is still being developed, and will probably
change a lot. See [this thread][thread] from emacs-devel for more
@@ -39,14 +39,16 @@ Bugs
----
Bugs or comments can be submitted to my [public inbox][mail].
-own.
+own. Note that non-trivial contributions require a [copyright
+assignment][ca] to the FSF.
Copying
-------
-`setup.el` is distributed under the [CC0 1.0 Universal (CC0 1.0)
+`setup.epl` is distributed under the [CC0 1.0 Universal (CC0 1.0)
Public Domain Dedication][cc0] license.
[thread]: https://lists.gnu.org/archive/html/emacs-devel/2021-02/msg00188.html
[mail]: https://lists.sr.ht/~zge/public-inbox
+[ca]:
https://www.gnu.org/software/emacs/manual/html_node/emacs/Copyright-Assignment.html#Copyright-Assignment
[cc0]: https://creativecommons.org/publicdomain/zero/1.0/deed
