rename screenshot image filename
[mu4e-marker-icons.git] / README.org
blob2078a82f8fced54088aa9f724bb2d9b4e004f0e4
1 * Intro
3 Display mu4e email flags with icons.
5 This package is a work after discussion on [[https://github.com/djcb/mu/issues/1795][mu4e GitHub issue]].
7 * Screenshot
9 [[file:all-the-icons.png]]
11 If you toggle option ~mu4e-marker-icons-use-unicode~. Then it will use unicode
12 icons, looks like this (This is totally from [[http://xenodium.com/mu4e-icons/][Álvaro Ramírez]], thanks!):
14 [[file:unicode-icons.png]]
16 * Installation
18 This package is already available on MELPA.
20 #+begin_src emacs-lisp
21 (use-package mu4e-marker-icons
22   :ensure t
23   :init (mu4e-marker-icons-mode 1))
24 #+end_src
26 * FAQ
28 ** Q: got Chinese characters when using mu4e-marker-icons
30 The icon displaying issues is caused by all-the-icons, it might related to your font supporting or
31 system environments etc. Please search old issues in all-the-icons GitHub Issues page.