Skip to content

Commit d29f423

Browse files
CopilotProject516
andcommitted
Improve README with clear sections for end users and developers
Co-authored-by: Project516 <138796702+Project516@users.noreply.github.com>
1 parent 06d2f89 commit d29f423

1 file changed

Lines changed: 55 additions & 5 deletions

File tree

README.md

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,61 @@
1-
# NumberGuessingGame
1+
# Number Guessing Game
22

3-
To run: Have at least Java 8 installed.
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.
44

5-
## Development set up
5+
## For End Users
6+
7+
### Requirements
8+
9+
- Java 8 or higher
10+
11+
### How to Run
12+
13+
**On Windows:**
14+
Run `run.bat`
15+
16+
**On Linux/Mac:**
17+
Run `run.sh` or execute `java -jar app.jar`
18+
19+
### How to Play
20+
21+
1. Start the game using one of the methods above
22+
2. Enter your guess when prompted
23+
3. The game will tell you if your guess is too high or too low
24+
4. Keep guessing until you find the correct number
25+
5. The game will display how many guesses it took you
26+
27+
## For Developers
28+
29+
### Requirements
30+
31+
- Java 8 or higher (Eclipse Temurin recommended)
32+
- Gradle
33+
34+
### Development Setup
635

736
Install SDKMAN! and run:
837

9-
`sdk install java 25-tem`
38+
```
39+
sdk install java 25-tem
40+
sdk install gradle
41+
```
42+
43+
Or install Eclipse Temurin JDK directly from https://adoptium.net/
44+
45+
### Building
46+
47+
```
48+
cd app
49+
gradle build
50+
```
51+
52+
### Running Tests
53+
54+
```
55+
cd app
56+
gradle test
57+
```
58+
59+
### Creating Release Archive
1060

11-
`sdk install gradle`
61+
Run `./package.sh` from the project root. This will create `archive.zip` containing the application and run scripts.

0 commit comments

Comments
 (0)