diff --git a/README.md b/README.md index 6abec8a..3dd6771 100644 --- a/README.md +++ b/README.md @@ -25,24 +25,24 @@ For Debian/Ubuntu and derivatives (recommended for terminal usage): You can use curl to do it from the command line: ```bash - curl -s -L -o numberguessinggame.deb https://github.com/Project516/NumberGuessingGame/releases/latest/download/numberguessinggame.deb + curl -s -L -o NumberGuessingGame.deb https://github.com/Project516/NumberGuessingGame/releases/latest/download/NumberGuessingGame.deb ``` 2. Install it: ```bash sudo apt update # Update packages - sudo apt install ./numberguessinggame.deb # From directory with the deb package + sudo apt install ./NumberGuessingGame.deb # From directory with the deb package sudo apt install -f # Install dependencies echo 'export PATH=$PATH:/usr/games' >> ~/.bashrc # Add games directory to user PATH source ~/.bashrc ``` 3. Run from anywhere in your terminal: ```bash - numberguessinggame + NumberGuessingGame ``` To uninstall: ```bash -sudo apt remove numberguessinggame +sudo apt remove NumberGuessingGame sudo apt autoremove -y # Remove dependencies ``` @@ -54,33 +54,33 @@ For Fedora, RHEL, CentOS, and other RPM-based distributions: You can use curl to do it from the command line: ```bash - curl -s -L -o numberguessinggame.rpm https://github.com/Project516/NumberGuessingGame/releases/latest/download/numberguessinggame.rpm + curl -s -L -o NumberGuessingGame.rpm https://github.com/Project516/NumberGuessingGame/releases/latest/download/NumberGuessingGame.rpm ``` 2. Install it: ```bash - sudo dnf install ./numberguessinggame.rpm + sudo dnf install ./NumberGuessingGame.rpm ``` Or on older systems: ```bash - sudo yum install ./numberguessinggame.rpm + sudo yum install ./NumberGuessingGame.rpm ``` 3. Run from anywhere in your terminal: ```bash - numberguessinggame + NumberGuessingGame ``` To uninstall: ```bash -sudo dnf remove numberguessinggame +sudo dnf remove NumberGuessingGame ``` Or on older systems: ```bash -sudo yum remove numberguessinggame +sudo yum remove NumberGuessingGame ``` ### Standalone Packages with Bundled JRE (Recommended) -Download the platform-specific package with bundled JRE from the [latest release](https://github.com/project516/numberguessinggame/releases): +Download the platform-specific package with bundled JRE from the [latest release](https://github.com/project516/NumberGuessingGame/releases): - **Windows**: `NumberGuessingGame-windows.zip` - **macOS**: `NumberGuessingGame-macos.zip` @@ -96,7 +96,7 @@ Run `run.sh` ### Manual Installation (Requires Java) -Download the `archive.zip` from the [latest release](https://github.com/project516/numberguessinggame/releases) +Download the `archive.zip` from the [latest release](https://github.com/project516/NumberGuessingGame/releases) #### Requirements @@ -154,7 +154,7 @@ In console mode: ### High Scores -The game automatically tracks high scores (games won with the least guesses). High scores are stored in your home directory at `~/.numberguessinggame/highscores.properties`. +The game automatically tracks high scores (games won with the least guesses). High scores are stored in your home directory at `~/.NumberGuessingGame/highscores.properties`. - The top 10 scores are kept - Scores are sorted by the number of guesses (least is best) @@ -195,21 +195,21 @@ Run `.\gradlew build` and `.\package.bat` from the project root. **On Linux/Mac:** Run `./package.sh` from the project root. -This will create `archive.zip` containing the application, run scripts, README, and LICENSE. The archive can be released to GitHub Releases. +This will create `archive.zip` containing the application, run scripts, README, and LICENSE. #### Debian Package **On Linux:** Run `./package-deb.sh` from the project root. -This will create `numberguessinggame.deb` which can be installed via `apt`/`dpkg` on Debian-based systems. The package can be released to GitHub Releases for easy distribution. +This will create `NumberGuessingGame.deb` which can be installed via `apt`/`dpkg` on Debian-based systems. #### Fedora/RPM Package **On Linux (requires rpm-build):** Run `./package-rpm.sh` from the project root. -This will create `numberguessinggame-1.0.0-1.noarch.rpm` which can be installed via `dnf`/`yum`/`rpm` on Fedora, RHEL, CentOS, and other RPM-based systems. The package can be released to GitHub Releases for easy distribution. +This will create `NumberGuessingGame.rpm` which can be installed via `dnf`/`yum`/`rpm` on Fedora, RHEL, CentOS, and other RPM-based systems. #### Platform-Specific Packages with Bundled JRE @@ -222,4 +222,4 @@ Run the following scripts to create platform-specific packages with bundled JRE: ./package-linux.sh # Creates NumberGuessingGame-linux.tar.xz ``` -These packages include a bundled JRE and do not require Java to be installed on the target system. They are automatically built and uploaded to GitHub Releases via GitHub Actions. +These packages include a bundled JRE and do not require Java to be installed on the target system.