aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Willemse2016-02-21 14:54:15 +0100
committerTom Willemse2016-02-21 14:54:15 +0100
commit0d44ed2e32fefe45c14a4186095e8e145d0e44e3 (patch)
tree8aab4fc2cae356eddb3ecf1d46308091497215be
parent667d5c890a76e18c4fdf64d9ed7b19a52fd6cd97 (diff)
downloadmode-icons-0d44ed2e32fefe45c14a4186095e8e145d0e44e3.tar.gz
mode-icons-0d44ed2e32fefe45c14a4186095e8e145d0e44e3.zip
Update README
-rw-r--r--README.org14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.org b/README.org
index 2a5107f..cc3c619 100644
--- a/README.org
+++ b/README.org
@@ -6,7 +6,7 @@ Show icons instead of mode names in emacs.
[[https://raw.githubusercontent.com/rhoit/mode-icons/dump/screenshots/screenshot01.png]]
-Modes that have icons instead of names now:
+Some of the modes that have icons instead of names now:
| Modes | icon |
|------------+--------------------------------------------------------------------------|
@@ -28,7 +28,19 @@ Modes that have icons instead of names now:
| Slim | [[https://raw.githubusercontent.com/rhoit/mode-icons/dump/icons/slim.png]] |
| YAML | [[https://raw.githubusercontent.com/rhoit/mode-icons/dump/icons/yaml.png]] |
+* Requirements
+ As of version 0.3.0 you can also use icons from some icon fonts,
+ specifically:
+
+ - [[http://fontawesome.io/][Font Awesome]]
+ - [[https://octicons.github.com/][GitHub Octicons]]
+ - [[http://fizzed.com/oss/font-mfizz][Font Mfizz]]
+
+ You need to have installed these on your system in order to use
+ these fonts, mode-icons will not do this for you. If you don't have
+ them installed you may get some strange glyphs in your mode-line
+ instead.
* Installation