summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 3bcc17238a87e93a982af02da237e13f8e24ca5b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
CraftBukkit
===========

A Bukkit (Minecraft Server API) implementation

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
-----------

We use maven to handle our dependencies.

* Install [Maven 3](http://maven.apache.org/download.html)
* Check out and install [Bukkit](http://github.com/Bukkit/Bukkit)
    * *Note*: this is not needed as the repository we use has Bukkit too, but you might have a newer one (with your own changes :D)
* Check out this repo and: `mvn clean package`