summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorStefan Monnier <monnier@iro.umontreal.ca>2020-12-11 15:58:12 -0500
committerStefan Monnier <monnier@iro.umontreal.ca>2020-12-11 15:58:12 -0500
commitbcacdba842b8c37fed6767bfe8bf5202c0b0f6be (patch)
treecfadad1abcc634eef31a493cdbbbf714a3602779 /README
parent0f8fca3345a56d0657b5fe8c8425970705ed2264 (diff)
* elpa-admin.el: Add `:readme` and `:news` properties to specifications
(elpaa--get-section): Take a `pkg-spec` rather than the name of the main file. (elpaa--get-README, elpaa--get-NEWS): New functions. (elpaa--html-make-pkg): Use them. (elpaa--release-email): Take additional arg `dir`. Append the News.
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 12 insertions, 0 deletions
diff --git a/README b/README
index 0cc8fd9..3a83b70 100644
--- a/README
+++ b/README
@@ -93,6 +93,18 @@ Mapping from the source layout to the layout used in the tarball.
RENAMES is a list of element (FROM TO) where FROM should terminate with =/=
if it's a directory.
+** =:readme FILE=
+Name of the file to use as the description of the package. By default
+we try to use README, README.rst, README.org, or the Commentary section
+in the main file.
+
+** =:news FILE=
+Name of the file that contains the list of changes in recent versions
+(listed from more recent to least recent).
+By default we try to use NEWS, NEWS.rst, NEWS.md, NEWS.org, the News section
+in the main file.
+
+
* Text below this marker is OUTDATED and still needs to be reviewed/rewritten!!
* Packages