diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/README.org b/README.org new file mode 100644 index 0000000..ac4baf6 --- /dev/null +++ b/README.org @@ -0,0 +1,38 @@ +#+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 +[[file:demo.gif]] + +* Installation +You can install it by cloning this repo and adding =git-email.el= to your =load-path=. + +* Related packages +- [[https://git.kyleam.com/piem/][piem]] - gluing together public-inbox archives and git + +* Contributing +You can send patches to the [[https://lists.sr.ht/~yoctocell/git-email-devel][git-email-devel]] mailing list. + +*Note:* The README.md is generated from README.org |