Browse files

Add basic README

  • Loading branch information...
1 parent 91f867e commit 1a60471c23fa0c72e743bc1e2187e63179ecceea @purcell committed Nov 17, 2012
Showing with 30 additions and 0 deletions.
  1. +30 −0 README.md
View
30 README.md
@@ -0,0 +1,30 @@
+flymake-php.el
+==============
+
+An Emacs flymake handler for syntax-checking PHP 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-php.el` to your `load-path`, and then
+`(require 'flymake-php)`. 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-php)
+ (add-hook 'php-mode-hook 'flymake-php-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 1a60471

Please sign in to comment.