Skip to content

Commit a9da297

Browse files
committed
Merge branch 'master' of https://github.com/LoneDev6/FastNBT
2 parents 5bbd6fe + 401a551 commit a9da297

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# FastNBT
2+
<hr>
3+
<h3 align="center">
4+
<a href="https://lonedev6.github.io/FastNBT/">☕ JavaDocs</a> | <a href="https://github.com/LoneDev6/LoneLibs/tree/master">LoneLibs (includes FastNBT)</a>
5+
</h3>
6+
<hr>
7+
18
# Comparison to NBT API
29

310
## Installations
@@ -124,3 +131,10 @@ Should be all.
124131
- Run `node .\.mvn-exec\GenerateNms.js` (run it each time you edit something in the NMS files)
125132
- Run `mvn install` in order to access the plugin as dependency in your projects
126133
- Run Maven `clean package` and get the generated jar from `output` folder
134+
135+
## Updating Javadocs
136+
137+
In order to update Javadocs you have to build locally, as old NMS jars are not available and can't be easily included on Github.
138+
- Run the command `mvn clean install javadoc:javadoc -pl FastNbt-core -am`
139+
- Get the generated javadocs from `.cache/targets/FastNbt-core/target/reports/apidocs/`
140+
- Push the contents into the `javadoc` branch

0 commit comments

Comments
 (0)