Updated README.md

This commit is contained in:
Erik Broes 2011-02-05 16:11:37 +01:00
parent f24d79052c
commit 2706916a68

View File

@ -3,16 +3,6 @@ Bukkit
A Minecraft Server API. A Minecraft Server API.
Coding Conventions
-----------
* We generally follow the Sun/Oracle coding standards.
* No tabs; use 4 spaces instead.
* No trailing whitespaces.
* No 80 column limit or midstatement newlines.
Follow the above conventions if you want your pull requests accepted.
Compilation Compilation
----------- -----------
@ -20,3 +10,14 @@ We use maven to handle our dependencies.
* Install [Maven 3](http://maven.apache.org/download.html) * Install [Maven 3](http://maven.apache.org/download.html)
* Check out this repo and: `mvn clean install` * Check out this repo and: `mvn clean install`
Coding Conventions
-----------
* We generally follow the Sun/Oracle coding standards.
* No tabs; use 4 spaces instead.
* No trailing whitespaces.
* No 80 column limit or midstatement newlines.
* Proper javadoc for each method added/changed to describe what it does.
Follow the above conventions if you want your pull requests accepted.