Skip to content

Commit 8cba0d9

Browse files
CopilotProject516
andcommitted
Address review feedback: improve section headers, clarify requirements, and expand build instructions
Co-authored-by: Project516 <138796702+Project516@users.noreply.github.com>
1 parent d29f423 commit 8cba0d9

1 file changed

Lines changed: 13 additions & 7 deletions

File tree

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
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-
## For End Users
5+
## Running the Game
66

77
### Requirements
88

9-
- Java 8 or higher
9+
- Java 8 or higher (may require Java 17+ in future versions)
1010

1111
### How to Run
1212

@@ -24,26 +24,32 @@ Run `run.sh` or execute `java -jar app.jar`
2424
4. Keep guessing until you find the correct number
2525
5. The game will display how many guesses it took you
2626

27-
## For Developers
27+
## Development
2828

2929
### Requirements
3030

31-
- Java 8 or higher (Eclipse Temurin recommended)
31+
- Java 25 (Eclipse Temurin recommended for development)
3232
- Gradle
3333

3434
### Development Setup
3535

36-
Install SDKMAN! and run:
36+
SDKMAN is the recommended way to install Java and Gradle (pre-installed in GitHub Codespaces):
3737

3838
```
3939
sdk install java 25-tem
4040
sdk install gradle
4141
```
4242

43-
Or install Eclipse Temurin JDK directly from https://adoptium.net/
43+
Alternatively, install Eclipse Temurin JDK directly from https://adoptium.net/
4444

4545
### Building
4646

47+
From the project root:
48+
```
49+
gradle build
50+
```
51+
52+
Or from the app directory:
4753
```
4854
cd app
4955
gradle build
@@ -58,4 +64,4 @@ gradle test
5864

5965
### Creating Release Archive
6066

61-
Run `./package.sh` from the project root. This will create `archive.zip` containing the application and run scripts.
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)