From 9d9629feb37fc6af35b9576bd3b2c1a64d0d8638 Mon Sep 17 00:00:00 2001 From: Ryan Barlow <7389646+ryanbarlow97@users.noreply.github.com> Date: Sat, 3 Oct 2026 22:36:27 +0000 Subject: [PATCH] docs: put README sections in the standard order and add tests Co-Authored-By: Claude Opus 5.5 (1M context) --- README.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d7e4379..bdfd0fa 100644 --- a/README.md +++ b/README.md @@ -15,15 +15,6 @@ Sounds play at the performer's location for nearby listeners, while floating not - **Custom instrument items** — supports vanilla items and instrument items from MMOItems, ItemsAdder, and Nexo. - **In-game note reference** — players can view the keybind layout for the instrument they are holding. -## License - -MusicalInstruments is distributed under the [Artistic License 2.0](LICENSE). - -Copyright (c) 2026 Justinas Launikonis. -Copyright (c) 2026 TF-Minecraft contributors. - -Third-party dependencies retain their own licenses. - ## Credits Created by [Justinas Launikonis](https://github.com/JustinasLa). @@ -33,3 +24,18 @@ Created by [Justinas Launikonis](https://github.com/JustinasLa). [Project documentation](https://github.com/TF-Minecraft/Docs/blob/main/projects/MusicalInstruments/README.md) Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/TF-Minecraft/Docs). + +## Tests and coverage + +With Java 21 installed, run `mvn clean verify`. Tests use JUnit, Mockito, and +MockBukkit and run without a live Minecraft server. JaCoCo writes its report to +`target/site/jacoco/`, and `verify` requires 100% instruction and branch coverage. + +## License + +MusicalInstruments is distributed under the [Artistic License 2.0](LICENSE). + +Copyright (c) 2026 Justinas Launikonis. +Copyright (c) 2026 TF-Minecraft contributors. + +Third-party dependencies retain their own licenses.