The README spends a lot of time walking through the fine details of resource pack generation. That information needs to be documented, but having to slog through details about command-line flags before getting to the details about how exactly one gets music discs in the game is gonna lose a lot of people.
Going forward, the content in the README needs to be moved into either the repo wiki or gh-pages (mkdocs is bae).
This does not need to be done before the initial release, because to start the important bit is that the docs exist, and consequently the curseforge and modrinth description pages can be condensed to just give the fun bits up front and just and link to the technical bit.
The README spends a lot of time walking through the fine details of resource pack generation. That information needs to be documented, but having to slog through details about command-line flags before getting to the details about how exactly one gets music discs in the game is gonna lose a lot of people.
Going forward, the content in the README needs to be moved into either the repo wiki or gh-pages (mkdocs is bae).
This does not need to be done before the initial release, because to start the important bit is that the docs exist, and consequently the curseforge and modrinth description pages can be condensed to just give the fun bits up front and just and link to the technical bit.