Skip to content

Include the documentation in the release zip #118

Description

@SkowronskiAndrew

The release zips contain only the three binaries (UnityDataTool.exe, UnityFileSystemApi.dll, e_sqlite3.dll). No README, no license, no documentation, no pointer to anything beyond the URL embedded in --help output.

For anyone using the downloaded binary (rather than a clone), the entire documentation surface is that one URL — and it requires network access. The Documentation folder is ~100 KB of markdown; the zip is ~75 MB, so including it costs nothing.

Proposal — add to the release zip:

  • Documentation/ (the whole folder; it is interlinked markdown and works fine read locally)
  • README.md and LICENSE.md
  • Possibly a very short top-level README.txt for the zip itself: what the tool is, the suggestion to add the folder to PATH, and where the docs are.

This means updating the packaging step in the GitHub Actions release workflow. The docs in the zip would match the released version, which also mitigates the docs-version-skew problem of the --help link pointing at main.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions