Skip to content

Commit 320eb8d

Browse files
authored
docs: refresh README and testing guidance (#66)
* docs: refresh README and testing guidance * docs: correct seafood portion description
1 parent 2fd96f9 commit 320eb8d

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Cooking makes food an interactive part of everyday life. Players grow and gather
1111
- **Serving and sharing** — plate dishes, ladle soup into bowls, and carve foods into portions for the table.
1212
- **Quality and freshness** — ingredient quality and composition influence finished dishes, while aging and food tags carry preparation history through the kitchen.
1313
- **Farming and husbandry** — crop fertility and harvest quality sit alongside animal care, breeding, genetics, and produce collection.
14+
- **Fish and seafood** — turn supported catches into cooking ingredients while preserving catch size.
1415
- **Character nutrition** — meals feed a character's food reserve and influence diet quality, with variety rewarding a broader selection of ingredients.
1516

1617
## A complete food journey
@@ -25,18 +26,20 @@ Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/
2526

2627
## Tests
2728

28-
With Java 21 and the pinned plugin dependencies installed (see the build workflow), run:
29+
With Java 21 and the [build dependencies](https://github.com/TF-Minecraft/Docs/blob/main/projects/Cooking/README.md#build-and-dependencies) prepared, run:
2930

3031
```sh
3132
mvn -B --no-transfer-progress clean verify
3233
```
3334

3435
The JUnit 5 suite covers food parsing and items, crops, husbandry, nutrition,
3536
fishing and configuration loading, using MockBukkit and Mockito where Bukkit or
36-
plugin APIs are involved. The Build and release workflows run the same command,
37-
and the Build workflow uploads the Surefire reports. JaCoCo requires 100% line
38-
coverage across all production classes, with no coverage exclusions. HTML and XML
39-
reports are written to `target/site/jacoco/` and uploaded by the Build workflow.
37+
plugin APIs are involved. Build and release CI run the same verification. The
38+
Build workflow uploads Surefire results from `target/surefire-reports/`. JaCoCo
39+
requires 100% line coverage across all production classes, with no coverage
40+
exclusions. HTML and XML
41+
reports are `target/site/jacoco/index.html` and `target/site/jacoco/jacoco.xml`,
42+
and the Build workflow uploads that directory.
4043
The tests do not replace checking kitchens, crops and livestock on a live Paper
4144
server with the pinned integrations.
4245

0 commit comments

Comments
 (0)