aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2015-10-15 17:02:10 -0400
committerTeddy Wing2015-10-15 17:02:10 -0400
commit00ac81b72bdb781ffa1784c505c58225ffd78ebc (patch)
tree6e350e41316e854b239860f65da6aa29ac95940a
parent8606ac8ce8e7d872da5b77e644fd32ac4c7fd26b (diff)
downloadvim-space-vlaze-00ac81b72bdb781ffa1784c505c58225ffd78ebc.tar.bz2
Add README and demo gif
Include some very minor background information about the plugin along with an animated demo gif. Also include requirements, installation, and license information.
-rw-r--r--README.md26
-rw-r--r--demo.gifbin0 -> 589057 bytes
2 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..14f4173
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+vim-space-vlaze
+===============
+
+A space shooter game for Vim. Currently alpha with certain planned features not
+yet implemented.
+
+Here's an idea of what the gameplay looks like:
+
+![Demo](./demo.gif)
+
+
+## Requirements
+[mplayer](http://www.mplayerhq.hu/): to play game audio
+
+
+## Installation
+Install using any of the various Vim plugin managers. If you use
+[pathogen](https://github.com/tpope/vim-pathogen), you can run the following to
+install:
+
+ cd ~/.vim/bundle
+ git clone https://github.com/teddywing/vim-space-vlaze.git
+
+
+## License
+Licensed under the MIT license. See the included LICENSE file.
diff --git a/demo.gif b/demo.gif
new file mode 100644
index 0000000..8f0f41a
--- /dev/null
+++ b/demo.gif
Binary files differ