Merge pull request #52 from manuelgu/feature/readme

Revamped README file
This commit is contained in:
Jesse Boyd 2016-04-26 05:51:18 +10:00
commit ae1ce1f1b8

View File

@ -1,22 +1,25 @@
# About # FastAsyncWorldEdit
FAWE is an addon for WorldEdit that has huge speed and memory improvements as well as a few extra features. FAWE is an addon for WorldEdit that has huge speed and memory improvements as well as a few extra features.
# Spigot page ## Spigot page
https://www.spigotmc.org/resources/13932/ https://www.spigotmc.org/resources/13932/
# IRC ## IRC
http://webchat.esper.net/?nick=&channels=IntellectualCrafters Meet us on `irc.esper.net` in the `#IntellectualCrafters` channel or use the [webchat to join through browser](http://webchat.esper.net/?nick=&channels=IntellectualCrafters).
# Releases: ## Releases
You can find the most recent stable releases on GitHub
https://github.com/boy0001/FastAsyncWorldedit/releases https://github.com/boy0001/FastAsyncWorldedit/releases
# Building ## Building
> FAWE uses gradle to build FAWE uses gradle to build
gradlew setupDecompWorkspace ```
gradlew build $ gradlew setupDecompWorkspace
$ gradlew build
```
# Contributing ## Contributing
Have an idea for an optimization, or a cool feature? Have an idea for an optimization, or a cool feature?
- I'll accept most PR's - I'll accept most PR's
- Let me know what you've tested / what may need further testing - Let me know what you've tested / what may need further testing