Improve dev info in README
This commit is contained in:
parent
e0aa052305
commit
4a9ceecc29
1 changed files with 9 additions and 2 deletions
11
README.md
11
README.md
|
@ -10,10 +10,16 @@ This means your code won't break when the GamecraftModdingAPI or Gamecraft updat
|
|||
|
||||
For more info, please check out the [official documentation](https://mod.exmods.org).
|
||||
|
||||
For more support, join the ExMods [Discord](https://discord.gg/xjnFxQV).
|
||||
For more support, join the ExMods [Discord](https://discord.exmods.org).
|
||||
|
||||
## Installation
|
||||
[Please follow the official mod installation guide](https://www.exmods.org/guides/install.html)
|
||||
[Please follow the official mod installation guide](https://www.exmods.org/guides/install.html) or use GCMM.
|
||||
|
||||
## Development
|
||||
To get started, create a symbolic link called `ref` in the root of the project, or one folder higher, linking to the Gamecraft install folder.
|
||||
This will allow your IDE to resolve references to Gamecraft files for building and IDE tools.
|
||||
|
||||
GamecraftModdingAPI version numbers follow the [Semantic Versioning guidelines](https://semver.org/).
|
||||
|
||||
## External Libraries
|
||||
GamecraftModdingAPI includes [Harmony](https://github.com/pardeike/Harmony) to modify the behaviour of existing Gamecraft code.
|
||||
|
@ -21,4 +27,5 @@ GamecraftModdingAPI includes [Harmony](https://github.com/pardeike/Harmony) to m
|
|||
# Disclaimer
|
||||
This API is an unofficial modification of Gamecraft software, and is not endorsed or supported by FreeJam or Gamecraft.
|
||||
The GamecraftModdingAPI developer(s) claim no rights on the Gamecraft code referenced within this project.
|
||||
All code contained in this project is licensed under the [GNU Public License v3](https://git.exmods.org/modtainers/GamecraftModdingAPI/src/branch/master/LICENSE).
|
||||
|
||||
|
|
Loading…
Reference in a new issue