aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: ac4baf663f5214e2fbed63a6e38612b9f6c8ec5f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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