Skip to content

Commit 55c4548

Browse files
authored
Merge pull request #32 from Project516/copilot/fix-55ee7f3d-f4cf-488e-80ad-15872119adb3
Improve README with clear sections for end users and developers
2 parents 61e41cf + 8cba0d9 commit 55c4548

File tree

1 file changed

+62
-6
lines changed

1 file changed

+62
-6
lines changed

README.md

Lines changed: 62 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,67 @@
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+
## Running the Game
66

7-
Install SDKMAN! and run:
7+
### Requirements
88

9-
`sdk install java 25-tem`
9+
- Java 8 or higher (may require Java 17+ in future versions)
1010

11-
`sdk install gradle`
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+
## Development
28+
29+
### Requirements
30+
31+
- Java 25 (Eclipse Temurin recommended for development)
32+
- Gradle
33+
34+
### Development Setup
35+
36+
SDKMAN is the recommended way to install Java and Gradle (pre-installed in GitHub Codespaces):
37+
38+
```
39+
sdk install java 25-tem
40+
sdk install gradle
41+
```
42+
43+
Alternatively, install Eclipse Temurin JDK directly from https://adoptium.net/
44+
45+
### Building
46+
47+
From the project root:
48+
```
49+
gradle build
50+
```
51+
52+
Or from the app directory:
53+
```
54+
cd app
55+
gradle build
56+
```
57+
58+
### Running Tests
59+
60+
```
61+
cd app
62+
gradle test
63+
```
64+
65+
### Creating Release Archive
66+
67+
Run `./package.sh` from the project root. This will create `archive.zip` containing the application, run scripts, and README. The archive can be released to GitHub Releases.

0 commit comments

Comments
 (0)