aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2020-04-16 21:02:37 -0400
committerKyle Meyer <kyle@kyleam.com>2020-04-16 21:02:37 -0400
commit1b29068c705ba739d3da7723f67d6023f4f54f19 (patch)
treebdc887a8707146574901663ccbc712381e17d9af /README
parent846dbb7fce95a46fcff095434b5a4ed7e033e079 (diff)
downloadorg-link-edit-1b29068c705ba739d3da7723f67d6023f4f54f19.tar.gz
README: Drop .md extension
Diffstat (limited to 'README')
-rw-r--r--README39
1 files changed, 39 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..2cb15c2
--- /dev/null
+++ b/README
@@ -0,0 +1,39 @@
+Org Link Edit provides Paredit-inspired slurping and barfing commands
+for Org link descriptions.
+
+The commentary in [org-link-edit.el][el] contains more details.
+org-link-edit.el is available in Org's contrib directory. See the Org
+manual's [installation instructions][install] for information on using
+contributed packages.
+
+[el]: https://git.kyleam.com/org-link-edit/tree/org-link-edit.el#n24
+[install]: http://orgmode.org/org.html#Installation
+
+### Contributing
+
+Please send bug reports, feature requests, and other questions to
+[misc@inbox.kyleam.com][lst] with **[org-link-edit]** as the subject
+prefix. You can browse previous Org Link Edit discussions at
+<https://inbox.kyleam.com/misc/?q=s%3Aorg-link-edit>.
+
+If you'd like to contribute a patch, thank you! To keep open the
+possibility of including org-link-edit.el into Org proper or ELPA,
+contributors are required to [assign copyright][cpy] to the Free
+Software Foundation for [most changes][tny] .
+
+Please send patches to the same address listed above. You can
+generate the patch with
+
+ git format-patch --subject-prefix="PATCH org-link-edit" ...
+
+To avoid passing `--subject-prefix` each time you call `format-patch`,
+you can configure the repository's default prefix:
+
+ git config format.subjectPrefix "PATCH org-link-edit"
+
+For more information on sending patches, visit
+<https://git-send-email.io/>.
+
+[lst]: mailto:misc@inbox.kyleam.com
+[cpy]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Copyright-Assignment.html
+[tny]: https://orgmode.org/worg/org-contribute.html#org2cf82ab