mirror of
https://github.com/TotalFreedomMC/TF-PlotSquared.git
synced 2024-12-23 00:15:06 +00:00
Update README.md
This commit is contained in:
parent
3bec76e27a
commit
ec0281768d
1 changed files with 1 additions and 20 deletions
21
README.md
21
README.md
|
@ -29,28 +29,9 @@ is to provide a lag-free and smooth experience.
|
||||||
|
|
||||||
# Building
|
# Building
|
||||||
Gradle is the **recommended** way to build the project. Use `./gradlew build` in the main project directory to build the project. Gradle is required if you intend to build or develop the Sponge module.
|
Gradle is the **recommended** way to build the project. Use `./gradlew build` in the main project directory to build the project. Gradle is required if you intend to build or develop the Sponge module.
|
||||||
If you prefer to use maven, a `pom.xml` file is provided for working with the Bukkit part of the plugin.
|
|
||||||
|
|
||||||
# Contributing
|
# Contributing
|
||||||
If you feel like you can improve the plugin any way, then you are
|
See [here](https://github.com/IntellectualSites/PlotSquared/blob/breaking/CONTRIBUTING.md)
|
||||||
more than welcome to contribute to PlotSquared. It would be highly
|
|
||||||
appreciated if you made sure to test your code before committing it,
|
|
||||||
as it will save us a lot of time and effort.
|
|
||||||
|
|
||||||
### Code Style
|
|
||||||
|
|
||||||
If you are planning to commit any changes to the project,
|
|
||||||
it would be highly appreciated if you were to follow the
|
|
||||||
project code style conventions. To make this easier we have
|
|
||||||
provided settings that can be imported into your IDE.
|
|
||||||
|
|
||||||
**Eclipse:**
|
|
||||||
`Window > Preferences > Java > Code Style > Formatter`
|
|
||||||
Press `Import` and select `...path/to/project/code_style.xml`
|
|
||||||
|
|
||||||
**IntelliJ:**
|
|
||||||
`File > Settings > Editor > Code Style`. Next to "Scheme" there is a cog wheel, press that and then
|
|
||||||
`Import Scheme > IntelliJ IDEA Code Style XML` and then select `..path/to/project/code_style.xml`
|
|
||||||
|
|
||||||
## Suggestions
|
## Suggestions
|
||||||
Suggestions are welcome! We have a separate issue tracker for suggestions, that can be found in [this](https://github.com/IntellectualSites/PlotSquaredSuggestions) repository.
|
Suggestions are welcome! We have a separate issue tracker for suggestions, that can be found in [this](https://github.com/IntellectualSites/PlotSquaredSuggestions) repository.
|
||||||
|
|
Loading…
Reference in a new issue