aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README43
1 files changed, 43 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..c8ee8c5
--- /dev/null
+++ b/README
@@ -0,0 +1,43 @@
+#+TITLE: git-email
+#+AUTHOR: yoctocell
+#+EMAIL: public@yoctocell.xyz
+
+* Introduction
+=git-email= integrates git and email with Emacs, it offers three main
+functions for sending and receiving email with git.
+
+- =git-email-send-email= will send the marked files as patches using your
+ mail client of choice. This means that you have to first run
+ =git format-patch= to generate the patches.
+
+- =git-email-format-patch= will ask you for a revision and generate
+ patches for all the changes that occured between the revision and the
+ current HEAD. It will then prepare the patches as email messages in
+ the same way as =git-email-send-email=.
+
+- =git-email-apply-patch= will ask you for a project to cd into and then
+ apply the patch in the current buffer using =git am=. You can also
+ specify your own function to extract the patch from the buffer by
+ changing the =git-email-apply-patch-function= variable.
+
+You can see all the customizable variables running M-x =customize-group=
+RET =git-email= RET.
+
+* Demo
+
+
+* Installation
+You can install it by cloning this repo and adding =git-email.el= to your =load-path=.
+
+* Contributing
+You can send patches to the [[https://lists.sr.ht/~yoctocell/git-email-devel][git-email-devel]] mailing list.
+
+
+
+
+#+BEGIN_COMMENT
+Local variables:
+mode: org
+end:
+#+END_COMMENT
+