aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2015-10-08 04:32:10 -0400
committerTeddy Wing2015-10-08 04:33:16 -0400
commit78038c863df19509a5edbc6e8b97a43fdfe24ff6 (patch)
tree38a539295c219069ae7715a165da2dc5f8d407bb
parent7ca0e2b4e01b8b37405e6e7f25477bfae107c319 (diff)
downloadvim-space-vlaze-78038c863df19509a5edbc6e8b97a43fdfe24ff6.tar.bz2
Add docs
Write Vim help for the plugin including an introduction, information about the command and map provided, as well as gameplay instructions and maps. Also generate help tags.
-rw-r--r--doc/space_vlaze.txt56
-rw-r--r--doc/tags13
2 files changed, 67 insertions, 2 deletions
diff --git a/doc/space_vlaze.txt b/doc/space_vlaze.txt
index de64753..4285131 100644
--- a/doc/space_vlaze.txt
+++ b/doc/space_vlaze.txt
@@ -1,8 +1,60 @@
-*space_vlaze.vim*
+*space_vlaze.vim* A space shooter game
+Author: Teddy Wing <http://teddywing.com>
+License: MIT
+Version: 0.0.1
+
+==============================================================================
+INTRODUCTION *space_vlaze-introduction*
-INTRODUCTION
Captain Nolan and his crew on the Benten have completed a routine delivery
mission to Chapek 9. As they make their way home through the Maze system,
their ship is suddenly assailed by giant floating popcorn kernels! Help Nolan
and the Benten pop the kernels before it's too late.
+
+==============================================================================
+COMMANDS *space_vlaze-commands*
+
+:SpaceVlaze *SpaceVlaze*
+ Launch the game. A prompt appears to perform one of the following:
+
+ 1. Play the game
+ 2. Display the leaderboard
+ 3. Show this help
+
+==============================================================================
+MAPPINGS *space_vlaze-mappings*
+
+ *space_vlaze-<leader>sv*
+<leader>sv Launch Space Vlaze.
+
+==============================================================================
+GAMEPLAY *space_vlaze-gameplay*
+
+Take control of Captain Nolan and the Benten. Navigate the treacherous expanse
+of space avoiding or popping the fearsome kernels.
+
+ *space_vlaze-h*
+h Move the Benten left.
+
+ *space_vlaze-j*
+j Move the Benten down.
+
+ *space_vlaze-k*
+k Move the Benten up.
+
+ *space_vlaze-l*
+l Move the Benten right.
+
+ *space_vlaze-<space>*
+<space> Fire missiles.
+
+ *space_vlaze-q*
+q Quit the game.
+
+==============================================================================
+LICENSE *space_vlaze-license*
+
+Space Vlaze is released under the MIT license.
+
+ vim:tw=78:ts=8:ft=help:norl:
diff --git a/doc/tags b/doc/tags
index c9b6ad9..755d64c 100644
--- a/doc/tags
+++ b/doc/tags
@@ -1 +1,14 @@
+SpaceVlaze space_vlaze.txt /*SpaceVlaze*
+space_vlaze-<leader>sv space_vlaze.txt /*space_vlaze-<leader>sv*
+space_vlaze-<space> space_vlaze.txt /*space_vlaze-<space>*
+space_vlaze-commands space_vlaze.txt /*space_vlaze-commands*
+space_vlaze-gameplay space_vlaze.txt /*space_vlaze-gameplay*
+space_vlaze-h space_vlaze.txt /*space_vlaze-h*
+space_vlaze-introduction space_vlaze.txt /*space_vlaze-introduction*
+space_vlaze-j space_vlaze.txt /*space_vlaze-j*
+space_vlaze-k space_vlaze.txt /*space_vlaze-k*
+space_vlaze-l space_vlaze.txt /*space_vlaze-l*
+space_vlaze-license space_vlaze.txt /*space_vlaze-license*
+space_vlaze-mappings space_vlaze.txt /*space_vlaze-mappings*
+space_vlaze-q space_vlaze.txt /*space_vlaze-q*
space_vlaze.vim space_vlaze.txt /*space_vlaze.vim*