Skip to content

docs: fix incorrect zip packaging script names in README#160

Merged
Project516 merged 1 commit into
Project516:masterfrom
cappy-dev:docs/fix-zip-packaging-script-names
Jul 8, 2026
Merged

docs: fix incorrect zip packaging script names in README#160
Project516 merged 1 commit into
Project516:masterfrom
cappy-dev:docs/fix-zip-packaging-script-names

Conversation

@cappy-dev

Copy link
Copy Markdown
Contributor

Summary

While reading through the README, I noticed the Creating Release Archives → Zip Archive section references two packaging scripts that don't exist in the repository:

  • On Windows it instructs users to run .\package.bat
  • On Linux/macOS it instructs users to run ./package.sh

Neither of those files is present. The actual scripts are:

  • package-zip.bat (Windows)
  • package-zip.sh (Linux/macOS)

Following the current instructions verbatim produces a command not found / "is not recognized as an internal or external command" error.

Changes

Updated the Windows step to:

Run .\gradlew build and then .\package-zip.bat from the project root.
This will create archive.zip containing the application, run scripts, README, and LICENSE.

Updated the Linux/Mac step to:

Run ./gradlew build and then ./package-zip.sh from the project root.
This will create NumberGuessingGame-archive.zip containing the application, run scripts, README, and LICENSE.

I also corrected the documented output artifact name per platform: package-zip.bat produces archive.zip (via PowerShell Compress-Archive), while package-zip.sh produces NumberGuessingGame-archive.zip (via the zip utility). Both names now match what the respective scripts actually generate.

Verification

  • Confirmed via repo file listing that the only packaging batch/shell scripts present are: package-zip.bat, package-zip.sh, package-deb.sh, package-linux.sh, package-win.sh, package-macos.sh, and package-rpm.sh.
  • Confirmed the Windows .bat references archive.zip and the POSIX .sh references NumberGuessingGame-archive.zip in their respective archive-creation commands.
  • No other packaging sections (Debian, RPM, platform-specific) referenced non-existent scripts, so they were left unchanged to keep this PR minimal and focused.

Docs-only change; no code or build behavior is affected.

The README's "Creating Release Archives > Zip Archive" section
references packaging scripts that do not exist in the repository:

- package.bat  -> the actual file is package-zip.bat
- ./package.sh -> the actual file is ./package-zip.sh

Anyone following the documented steps would hit "command not found"
errors. This updates the Windows and Linux/macOS instructions to use
the correct script names and reflects the actual output artifacts
produced by each script (archive.zip on Windows via the .bat that uses
PowerShell Compress-Archive, and NumberGuessingGame-archive.zip on
Linux/macOS via the zip-based package-zip.sh).
@Project516 Project516 merged commit a9deec1 into Project516:master Jul 8, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants