Permalink
Browse files

Add basic README

  • Loading branch information...
1 parent e14e8e2 commit 1bca9b93a5a33a3a59939b8ff937ad621bb31386 @purcell committed Nov 17, 2012
Showing with 31 additions and 0 deletions.
  1. +31 −0 README.md
View
31 README.md
@@ -0,0 +1,31 @@
+flymake-ruby.el
+===============
+
+An Emacs flymake handler for syntax-checking Ruby source code.
+
+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-ruby.el` to your `load-path`, and then
+`(require 'flymake-ruby)`. 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-ruby)
+ (add-hook 'ruby-mode-hook 'flymake-ruby-load)
+
+
+[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 1bca9b9

Please sign in to comment.