[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/setup 295e173 12/19: Update README
From: |
Stefan Monnier |
Subject: |
[elpa] externals/setup 295e173 12/19: Update README |
Date: |
Mon, 15 Mar 2021 17:26:28 -0400 (EDT) |
branch: externals/setup
commit 295e1736f7ebbf0813c74d8623421bff6b3f078c
Author: Philip K <philipk@posteo.net>
Commit: Philip K <philipk@posteo.net>
Update README
---
README.md | 19 ++++++++++++++-----
1 file changed, 14 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 9e25927..760ea4f 100644
--- a/README.md
+++ b/README.md
@@ -50,9 +50,18 @@ will be replaced with the functional equivalent of
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
-information.
+Installation
+------------
+
+`setup.el` is part of [GNU ELPA][elpa], and can be installed using
+`package.el`.
+
+Usage
+-----
+
+The `setup` macro is autoloaded, and can be used directly. The code
+generated by `setup` does not depend on `setup.el`, meaning that your
+initialization file can be byte-compiled more efficiently.
Bugs
----
@@ -64,10 +73,10 @@ assignment][ca] to the FSF.
Copying
-------
-`setup.epl` is distributed under the [CC0 1.0 Universal (CC0 1.0)
+`setup.el` 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
+[elpa]: http://elpa.gnu.org/packages/setup.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
- [elpa] externals/setup 0e4995f 15/19: Use fenced code block for example, (continued)
- [elpa] externals/setup 0e4995f 15/19: Use fenced code block for example, Stefan Monnier, 2021/03/15
- [elpa] externals/setup 7fddc97 17/19: Explain usage of keywords for local macros, Stefan Monnier, 2021/03/15
- [elpa] externals/setup 8ca0d20 18/19: Bump version to 0.1.1, Stefan Monnier, 2021/03/15
- [elpa] externals/setup c9bc47a 16/19: Simplify edebug specification generation, Stefan Monnier, 2021/03/15
- [elpa] externals/setup 39accbf 19/19: Mention GitHub mirror, Stefan Monnier, 2021/03/15
- [elpa] externals/setup 578f7bb 04/19: Update setup-define docstring, Stefan Monnier, 2021/03/15
- [elpa] externals/setup 894819d 10/19: Drop "none" as argument for :debug, Stefan Monnier, 2021/03/15
- [elpa] externals/setup d9a5850 02/19: Manually specify macro arity via :repeatable, Stefan Monnier, 2021/03/15
- [elpa] externals/setup 1bfca33 03/19: Avoid manual signature specification via help-function-arglist, Stefan Monnier, 2021/03/15
- [elpa] externals/setup fc958ad 08/19: Rename :needs argument to executable, Stefan Monnier, 2021/03/15
- [elpa] externals/setup 295e173 12/19: Update README,
Stefan Monnier <=
- [elpa] externals/setup 9bd5f5b 14/19: Fix markdown code syntax, Stefan Monnier, 2021/03/15
- [elpa] externals/setup e8a5ac7 07/19: Rename :hook argument to function, Stefan Monnier, 2021/03/15
- [elpa] externals/setup 5e24fe1 11/19: Decrease required Emacs version to 24.4, Stefan Monnier, 2021/03/15
- [elpa] externals/setup 9d9f5ef 13/19: Rename arguments to avoid manual :signatures specifications, Stefan Monnier, 2021/03/15