#+TITLE: git-email
#+AUTHOR: Xinglu Chen
#+EMAIL: public@yoctocell.xyz

* Introduction
=git-email= integrates git and email with Emacs, it offers two main
functions for sending 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=.

You can see all the customizable variables running =M-x =customize-group=
=<RET> =git-email <RET>=.

If you want to easily apply patches you have recieved via email, you
should checkout [[https://git.kyleam.com/piem][piem]].

* Demo
[[file:demo.gif]]

* Features
=git-email= offers minor modes for Gnus and Notmuch, these minor modes
will just configure some variables for you and provide any extra
functionality as of right now.

There is also integration with magit in the =git-email-magit.el=
library.  This will faciliate the transient library, you can send a
patch from the magit status buffer by pressing =W c s=.

* 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 and bug reports to the [[https://lists.sr.ht/~yoctocell/git-email-devel][git-email-devel]] mailing list.

*Note:* The README.md is generated from README.org