Permalink
Browse files

Add basic README

  • Loading branch information...
1 parent 3e56d47 commit 27fd71d948e85496e92cd965c3030ea427ef22d1 @purcell committed Nov 17, 2012
Showing with 34 additions and 0 deletions.
  1. +34 −0 README.md
View
@@ -0,0 +1,34 @@
+flymake-css.el
+==============
+
+An Emacs flymake handler for syntax-checking CSS source code
+using [`csslint`](https://github.com/stubbornella/csslint).
+
+Installation
+=============
+
+If you choose not to use one of the convenient packages in
+[Melpa][melpa] and [Marmalade][marmalade], you'll need to add the
+directory containing `flymake-css.el` to your `load-path`, and then
+`(require 'flymake-css)`. You'll also need to install
+[flymake-easy](https://github.com/purcell/flymake-easy).
+
+Usage
+=====
+
+Add the following to your emacs init file:
+
+ (require 'flymake-css)
+ (add-hook 'css-mode-hook 'flymake-css-load)
+
+Beware that csslint is quite slow, so there can be a significant lag
+between editing and the highlighting of resulting errors.
+
+[marmalade]: http://marmalade-repo.org
+[melpa]: http://melpa.milkbox.net
+
+<hr>
+
+[![](http://api.coderwall.com/purcell/endorsecount.png)](http://coderwall.com/purcell)
+
+[![](http://www.linkedin.com/img/webpromo/btn_liprofile_blue_80x15.png)](http://uk.linkedin.com/in/stevepurcell)

0 comments on commit 27fd71d

Please sign in to comment.