From 6a2f313af1e63172e52d91094d29f0a9a40d987a Mon Sep 17 00:00:00 2001 From: md_5 Date: Thu, 18 Dec 2014 11:00:52 +1100 Subject: Add initial README rewrite. --- README.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index a51766e6..bfb20177 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,25 @@ Bukkit ====== +A plugin API for [Minecraft](https://minecraft.net/) servers, currently maintained by [SpigotMC](http://www.spigotmc.org/). -A Minecraft Server API. - -Website: [http://bukkit.org](http://bukkit.org) -Bugs/Suggestions: [http://leaky.bukkit.org](http://leaky.bukkit.org) -Contributing Guidelines: [CONTRIBUTING.md](https://github.com/Bukkit/Bukkit/blob/master/CONTRIBUTING.md) +Bug Reporting +------------- +The development team is very open to both bug and feature requests / suggestions. You can submit these on the [JIRA Issue Tracker](http://hub.spigotmc.org/jira/). Compilation ----------- +Bukkit is a Java program which uses [Maven 3](http://maven.apache.org/) for compilation. To compile fresh from Git, simply perform the following steps: +* Install Maven and Git using your preferred installation methods. +* `git clone https://hub.spigotmc.org/stash/scm/spigot/bukkit.git`. +* `mvn clean install`. + +Some IDEs such as [NetBeans](https://netbeans.org/) can perform these steps for you. Any Maven capable Java IDE can be used to develop with Bukkit, however the current team's personal preference is to use NetBeans. -We use maven to handle our dependencies. - -* Install [Maven 3](http://maven.apache.org/download.html) -* Check out this repo and: `mvn clean install` +Contributing +------------ +Contributions of all sorts are welcome. To manage community contributions, we use the pull request functionality of Stash. In to gain access to Stash and create a pull request, you will first need to perform the following steps: +* Create an account on [JIRA](http://hub.spigotmc.org/jira/). +* Fill in the [SpigotMC CLA](http://www.spigotmc.org/go/cla) and wait up to 24 hours for your Stash account to be activated. Please ensure that your username and email addresses match. +* Log into Stash using your JIRA credentials. + +Once you have performed these steps you can create a fork, push your code changes, and then submit it for review. -- cgit v1.2.3