Replace README.md with README.org

This commit is contained in:
Tom Willemse 2013-06-02 14:14:58 +02:00
parent 1e8fcc4982
commit 7abc02827e
2 changed files with 33 additions and 32 deletions

View file

@ -1,32 +0,0 @@
# Mode-icons
Show icons instead of mode names in emacs.
Modes that have icons instead of names now:
* Emacs-Lisp
* Python
* Scheme
* 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.

33
README.org Normal file
View file

@ -0,0 +1,33 @@
#+STARTUP: showall
* Mode-icons
Show icons instead of mode names in emacs.
Modes that have icons instead of names now:
- Emacs-Lisp
- Python
- Scheme
- Lisp
- PHP
- HTML
** Installation
To install use either method:
*** package.el
If you have [[http://gnu.org/software/emacs][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
[[http://gnu.org/software/emacs][Emacs]] init file.