|
2 | 2 |
|
3 | 3 | A simple number guessing game where you try to guess a randomly generated number. The game will tell you if your guess is too high or too low until you find the correct number. |
4 | 4 |
|
5 | | -## Running the Game |
| 5 | +## Installation & Running |
| 6 | + |
| 7 | +### Installation via Debian Package (Linux) |
| 8 | + |
| 9 | +For Debian/Ubuntu and derivatives (recommended for terminal usage): |
| 10 | + |
| 11 | +1. Download the `.deb` package from the [latest release](https://github.com/Project516/NumberGuessingGame/releases) |
| 12 | +2. Install it: |
| 13 | + ```bash |
| 14 | + sudo apt update # Update packages |
| 15 | + sudo apt install ./numberguessinggame.deb # From directory the deb package is in |
| 16 | + sudo apt install -f # Install dependencies if needed |
| 17 | + ``` |
| 18 | +3. Run from anywhere in your terminal: |
| 19 | + ```bash |
| 20 | + numberguessinggame |
| 21 | + ``` |
| 22 | + |
| 23 | +To uninstall: |
| 24 | +```bash |
| 25 | +sudo apt remove numberguessinggame |
| 26 | +``` |
6 | 27 |
|
7 | | -### Requirements |
| 28 | +### Manual Installation |
| 29 | + |
| 30 | +#### Requirements |
8 | 31 |
|
9 | 32 | - Java 8 or higher (may require Java 17+ in future versions) |
10 | 33 |
|
11 | | -### How to Run |
| 34 | +#### How to Run |
12 | 35 |
|
13 | 36 | **On Windows:** |
14 | 37 | Run `run.bat` |
@@ -55,12 +78,21 @@ gradle build |
55 | 78 | gradle test |
56 | 79 | ``` |
57 | 80 |
|
58 | | -### Creating Release Archive |
| 81 | +### Creating Release Archives |
| 82 | + |
| 83 | +#### Zip Archive |
59 | 84 |
|
60 | 85 | **On Windows:** |
61 | | -Run `.\gradlew build` and `package.bat` from the project root. |
| 86 | +Run `.\gradlew build` and `.\package.bat` from the project root. |
62 | 87 |
|
63 | 88 | **On Linux/Mac:** |
64 | 89 | Run `./package.sh` from the project root. |
65 | 90 |
|
66 | | -This will create `archive.zip` containing the application, run scripts, and README. The archive can be released to GitHub Releases. |
| 91 | +This will create `archive.zip` containing the application, run scripts, README, and LICENSE. The archive can be released to GitHub Releases. |
| 92 | + |
| 93 | +#### Debian Package |
| 94 | + |
| 95 | +**On Linux:** |
| 96 | +Run `./package-deb.sh` from the project root. |
| 97 | + |
| 98 | +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. |
0 commit comments