[nongnu] elpa/pacmacs 03bdb3388f 012/472: Add README. Close #18

[ELPA Syncer]

branch: elpa/pacmacs
commit 03bdb3388fa07308acb917601c58a5053f7c524b
Author: rexim <reximkut@gmail.com>
Commit: rexim <reximkut@gmail.com>

    Add README. Close #18
---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..f97ca8b5d8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Pacman for Emacs #
+
+## Usage ##
+
+1. Clone the repo somewhere and cd to it: `$ git clone 
git://github.com/rexim/pacman.el.git && cd pacman.el`
+2. The game requires a sprite sheet file, but we currently do not provide it. 
You have to find it (or even make it) yourself. Current sprite sheet 
requirements:
+    1. The sprite sheet file should be localted at the games folder
+    2. The sprite sheet file should be named `pacman10-hp-sprite.png`
+    3. The sprite sheet should have at least three frames at the following 
coordinates (in the format `X Y WIDTH HEIGHT`)
+        - `20 0 20 20`
+        - `0  0 20 20`
+        - `40 0 20 20`
+3. Open `pacman.el` file in Emacs
+4. Eval entire file: `M-x eval-buffer`
+5. Start the game: `M-x pacman-start`