diff options
| -rw-r--r-- | README | 43 | ||||
| -rw-r--r-- | README.md | 20 |
2 files changed, 43 insertions, 20 deletions
@@ -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 + diff --git a/README.md b/README.md deleted file mode 100644 index d6d31b4..0000000 --- a/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# git-email -## Introduction -This package integrates with git and `message-mode` and offers three main functions - `git-email-send-email`, `git-email-format-patch` and `git-email-apply-patch`. - -`git-email-send-email` sends an email based on a patch file generated by -'git format-patch`. It inserts the relevant headers and the diff into the -message buffer. - -`git-email-format-patch` is a wrapper for 'git format-patch' and it -automatically composes an email for each generated patch, in the same way -as `git-email-send-email'. - -`git-email-apply-patch` will apply the patch that you are currently viewing -and it will ask to for the project that the patch belongs to. - -## Installation -You can install it by cloning this repo and adding `git-email.el` to your `load-path`. - -## Contributing: -You can contribute patches to the project via the [git-email-devel](https://lists.sr.ht/~yoctocell/git-email-devel) list, using [git send-email](https://git-send-email.io/). |