diff --git a/README.md b/README.md index b83864458..e9c9cf93b 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,40 @@

-**Advanced Achievements enables unique and challenging achievements on Minecraft servers running Bukkit or Spigot. Try to collect as many achievements as you can, earn rewards, climb the rankings and receive RP books!** +**Advanced Achievements enables unique and challenging achievements on Minecraft servers running Bukkit or Spigot. Try to collect as many achievements as you can, earn rewards, climb the rankings and receive RP books! The plugin supports SQLite, MySQL and PostgreSQL, integrates a complex statistics system, handles configuration and language YAML files and features fancy in-game GUIs!** # Contributing -Contributions are happily accepted through pull requests on GitHub. Feel free to fork the project and share your code. You can also star the project if you like it ! +Contributions are happily accepted through **pull requests** on GitHub. Feel free to fork the project and share your code, or improve and update the available translations! + +You can also **star this repository** to support the open-source project! # Useful links -For more information, please visit the project's webpages: +The **Wiki** of Advanced Achievements is available by clicking on the Wiki tab at the top of the page, or directly on [this link](https://github.com/PyvesB/AdvancedAchievements/wiki). Many valuable information on how to set up the plugin or use it is at your disposal! -[Advanced Achievements - Bukkit](http://dev.bukkit.org/bukkit-plugins/advanced-achievements/) +For more *information and download links*, please visit the project's webpages: [Advanced Achievements - Spigot](https://www.spigotmc.org/resources/advanced-achievements.6239/) +[Advanced Achievements - Bukkit](http://dev.bukkit.org/bukkit-plugins/advanced-achievements/) + Feel free to visit **HelloMinecraft**, the plugin's official server (french server): [![HelloMinecraft](http://img11.hostingpics.net/pics/487719servericon.png)](http://hellominecraft.fr/) +# Setting your own working copy of the project + +Ensure you have a working version of the [JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html). + +The following steps are for the [Eclipse](https://eclipse.org/) development environment, but will be similar on other IDEs. + +* Download or clone the repository on your computer. You can also create your own fork by clicking on the Fork icon on the top right of the page. +* In Eclipse, go to *File* -> *Import...* -> *Maven* -> *Existing Maven Projects*. +* In the *Root Directory* field, select the location where you downloaded the Advanced Achievements repository. +* Tick the *pom.xml* box that appears in the *Projects* field and click *Finish*. +* To compile the plugin, in the *Package Explorer* window, right click on the imported project, then *Run As* -> *Maven Install*. +* The plugin will be generated in the *target* folder of the project. + +Please let me know if you encounter any problems by opening an Issue, I am happy to help.