summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Tom Willemsen2012-11-11 03:11:34 +0100
committerGravatar Tom Willemsen2012-11-11 03:11:34 +0100
commite2fa1e17306e4120df6c67479309d92f0d05a447 (patch)
tree0e9da9df464c696dea4701c517cdde796805c30d
parent19edd6f6e2e73b55a506d846446d43197ddea14f (diff)
downloadmode-icons-e2fa1e17306e4120df6c67479309d92f0d05a447.tar.gz
mode-icons-e2fa1e17306e4120df6c67479309d92f0d05a447.zip
Update README
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 21b41e0..9066b75 100644
--- a/README.md
+++ b/README.md
@@ -10,3 +10,23 @@ Modes that have icons instead of names now:
* Lisp
* PHP
* HTML
+
+## Installation
+
+To install use either method:
+
+### package.el
+
+If you have [Emacs](http://gnu.org/software/emacs) 24 or `package.el`
+installed manually you can just create the tar file and use
+`package-install-file` to install it.
+
+#### Create the tar file
+
+Use `make dist` to create the tar file needed for `package.el`.
+
+### manually
+
+Place `mode-icons.el` somewhere in your `load-path` and copy the
+`icons/` directory there as well. Then `require` `mode-icons` in your
+[Emacs](http://gnu.org/software/emacs) init file.