aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2020-04-16 21:24:34 -0400
committerKyle Meyer <kyle@kyleam.com>2020-04-16 21:24:34 -0400
commit8f86dac7e775a2d678db6414b0ee0f6d82bb0c8e (patch)
tree87df6917ed997b23ddee18146c183d54e55e1fc6 /README
parentef82dfdf5ce1ae98b16b496ce5f975b95775b4eb (diff)
downloadannexview-8f86dac7e775a2d678db6414b0ee0f6d82bb0c8e.tar.gz
README: Rewrite
Diffstat (limited to 'README')
-rw-r--r--README40
1 files changed, 22 insertions, 18 deletions
diff --git a/README b/README
index eed2612..65b64d0 100644
--- a/README
+++ b/README
@@ -1,29 +1,33 @@
-Annexview is an Emacs Dired interface for modifying [git-annex
-metadata][gxm] and for creating [metadata-driven views][mdv]. See the
-[package commentary][com] for more details.
-[gxm]: https://git-annex.branchable.com/metadata/
-[mdv]: https://git-annex.branchable.com/tips/metadata_driven_views/
-[com]: https://git.kyleam.com/annexview/tree/annexview.el#n24
+Annexview is an Emacs Dired interface for modifying git-annex metadata
+[^1] and for creatingmetadata-driven views [^2]. See the package
+commentary more details.
-### Contributing
+[^1]: https://git-annex.branchable.com/metadata/
+[^2]: https://git-annex.branchable.com/tips/metadata_driven_views/
-Please send bug reports, feature requests, and other questions to
-[misc@inbox.kyleam.com][lst] with **[annexview]** as the subject
-prefix. You can browse previous Annexview discussions at
-<https://inbox.kyleam.com/misc/?q=s%3Aannexview>.
-If you'd like to contribute a patch, thank you! Please send
-it to the same address. You can generate the patch with
+Contributing
+------------
+
+Bug reports, patches, questions, and other feedback are welcome.
+Please send a plain-text email, with "[annexview]" as the subject
+prefix, to
+
+ misc@inbox.kyleam.com
+
+To add this prefix to patches, you can generate the them with
git format-patch --subject-prefix="PATCH annexview" ...
-To avoid passing `--subject-prefix` each time you call `format-patch`,
-you can configure the repository's default prefix:
+To avoid passing --subject-prefix each time you call format-patch, you
+can configure the repository's default prefix:
git config format.subjectPrefix "PATCH annexview"
-For more information on sending patches, visit
-<https://git-send-email.io/>.
+Messages that include the address above are public and available as
+public-inbox [^3] archives at
+
+ https://inbox.kyleam.com/misc/?q=s%3Aannexview
-[lst]: mailto:misc@inbox.kyleam.com
+[^3]: https://public-inbox.org/README