Convert all GitHub wiki pages into ReStructuredText documents, set up ReadTheDocs

This commit is contained in:
Justin W. Flory
2017-12-02 19:16:17 -05:00
parent 48ae60e070
commit 79c607f96d
20 changed files with 2552 additions and 3 deletions
+9 -3
View File
@@ -1,9 +1,11 @@
# MobArena
[![Build Status](https://travis-ci.org/garbagemule/MobArena.svg?branch=master)](https://travis-ci.org/garbagemule/MobArena)
MobArena [![Build Status](https://travis-ci.org/garbagemule/MobArena.svg?branch=master)](https://travis-ci.org/garbagemule/MobArena) [![Documentation Status](https://readthedocs.org/projects/mobarena/badge/?version=latest)](http://mobarena.readthedocs.io/en/latest/?badge=latest)
========
MobArena is an arena-style minigame for Spigot-based Minecraft servers
MobArena is an arena-style minigame for Bukkit-based Minecraft servers.
## Getting Started
If you don't want to compile the plugin yourself, grab a release artifact from
one of these two sites:
@@ -13,7 +15,9 @@ one of these two sites:
The wiki here on Github should have all the information you need to get
started using the plugin.
## Getting Help
If you run into problems or need help with something, feel free to hop on IRC
(#mobarena @ irc.esper.net) to have a chat. If you don't know what IRC is or
don't have an IRC client, you can use a web-based one:
@@ -24,7 +28,9 @@ Remember, though, that IRC is _idle chat_, which means you likely won't get a
response immediately. It could take anything from a couple of seconds to a
day, but your message _will_ be seen.
## Bugs and Suggestions
Found a bug or have a great idea for the plugin? Use the issue tracker here on
Github to submit a bug report or feature request. Please have a look through
the existing issues before you post a new one to avoid duplicates.