Update README.md

This commit is contained in:
dfsek
2020-10-14 22:08:55 -07:00
parent 4a3787fe67
commit e2eadaaddf
2 changed files with 12 additions and 2 deletions

View File

@@ -1,2 +1,13 @@
# Terra
Terra is a data-driven world generator based on [Gaea](https://github.com/PolyhedralDev/Gaea).
## Building and running Terra
To run Terra on a test server, clone this repo, package with Maven, then run `test.sh`. The script will clone a test
server skeleton (found [here](https://github.com/PolyhedralDev/WorldGenTestServer)) and set everything up to run.
**Note: You will need to adjust the `NAME` variable in test.sh if you are not using the default Terra config (you may
also change the value after server installation, in `bukkit.yml` of the test server)**
## Contributing
Contributions are welcome! If you want to see a feature in Terra, please, open an issue, or implement it yourself and
submit a PR!