branch: externals/agitate
commit 063d94c9836275de0a03b7cd1ea36de4700af45b
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Add generic README in markdown
This is because the README.org is not rendered properly by the various
Git forges. It is okay, because its real purpose is to generate the
Info manual (no, I will not bother with texi---thanks!).
---
README.md | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..4e2ac7c336
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# agitate: Extras for diff-mode, vc-git, log-edit, log-view
+
+Agitate is a collection of commands or potentially useful functions
+that expand on the available version control features of Emacs. Those
+are meant to complement a workflow that relies on the built-in Version
+Control framework and its accoutrements (`diff-mode.el`,
+`log-view.el`, `log-edit.el`, `vc-git.el`, and potentially others).
+
++ Package name (GNU ELPA): `agitate`
++ Official manual: <https://protesilaos.com/emacs/agitate> (the manual is
+ installed with the package---evaluate `(info "(agitate) Top")`)
++ Git repo on SourceHut: <https://git.sr.ht/~protesilaos/agitate>
+ - Mirrors:
+ + GitHub: <https://github.com/protesilaos/agitate>
+ + GitLab: <https://gitlab.com/protesilaos/agitate>
++ Mailing list: <https://lists.sr.ht/~protesilaos/agitate>
