aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README29
1 files changed, 29 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..eed2612
--- /dev/null
+++ b/README
@@ -0,0 +1,29 @@
+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
+
+### Contributing
+
+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
+
+ 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:
+
+ git config format.subjectPrefix "PATCH annexview"
+
+For more information on sending patches, visit
+<https://git-send-email.io/>.
+
+[lst]: mailto:misc@inbox.kyleam.com