aboutsummaryrefslogtreecommitdiff
path: root/doc/git-email.org
diff options
context:
space:
mode:
authorXinglu Chen <public@yoctocell.xyz>2021-02-04 16:55:25 +0100
committerXinglu Chen <public@yoctocell.xyz>2021-02-04 17:02:19 +0100
commit121d2e860397e428ffb296571ca5c2198b0f46ff (patch)
tree50c42234e42ec0d62eabe2c3cd6dcf2b3820604b /doc/git-email.org
parent150b33158b34ff5c23c306280ceb2290be339667 (diff)
README, manual: Update installation instructions
Add installation instructions for nix flakes.
Diffstat (limited to 'doc/git-email.org')
-rw-r--r--doc/git-email.org19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/git-email.org b/doc/git-email.org
index 84b1d23..cf6bdea 100644
--- a/doc/git-email.org
+++ b/doc/git-email.org
@@ -136,6 +136,25 @@ patch from the magit status buffer by pressing =W c s=.
* Installation
You can install it by cloning this repo and adding =git-email= to your =load-path=.
+** Nix
+If you are using [[https://nixos.wiki/wiki/Flakes][nix flakes]], three versions of the package are
+available:
+
+- =git-email-full-git= -- This includes all the optional libraries as
+ is built from the latest master branch.
+
+- =git-email-git= -- This only contains the core `git-email.el`
+ library and is built from the latest master branch.
+
+- =git-email= -- This is the package from the latest release.
+
+You can install the package with
+
+#+begin_src sh
+nix profile install "git+https://git.sr.ht/~yoctocell/git-email#git-email{-full-git,-git}"
+#+end_src
+
+
* Acknowledgements
Thank you Protesilaos Stavrou for your extensive testing and feedback!