about summary refs log tree commit diff
diff options
context:
space:
mode:
authorWilliam Carroll <wpcarro@gmail.com>2020-04-05T14·50+0100
committerWilliam Carroll <wpcarro@gmail.com>2020-04-05T14·50+0100
commit946ccfb2477504111ff35e0ef60b4a89bda71210 (patch)
tree698b11468e3615459ed16e21d2b2e55707f7e26e
parent8562bf5b5aaf4212fde5afabb122e8133a27464a (diff)
Tidy //emacs
TL;DR:
- Add README.md that includes instructions on how to install my Emacs
- Delete unused Makefile
-rw-r--r--emacs/Makefile5
-rw-r--r--emacs/README.md13
2 files changed, 13 insertions, 5 deletions
diff --git a/emacs/Makefile b/emacs/Makefile
deleted file mode 100644
index adaf8a61a132..000000000000
--- a/emacs/Makefile
+++ /dev/null
@@ -1,5 +0,0 @@
-install:
-	# TODO: I'd rather support `nix-env -f '<universe>' -iA emacs`, but at the
-	# moment this fails. I think it's failing because of the way I'm using
-	# readTree. I will need to investigate this further.
-	nix-env -f . -i
diff --git a/emacs/README.md b/emacs/README.md
new file mode 100644
index 000000000000..b4b16b32853f
--- /dev/null
+++ b/emacs/README.md
@@ -0,0 +1,13 @@
+# Emacs
+
+Emacs is one of a handful software projects that I highly value. I consider it
+as central to my workflow as `git` and `nix`.
+
+## Installing
+
+If you already have `briefcase` on your local file system, run the following
+from the top-level `briefcase` directory:
+
+```shell
+$ nix-build -f . -iA emacs.nixos
+```