From 06d2f891cb6dae4eb129f1c68ac723876c0a0678 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 6 Oct 2025 12:50:43 +0000 Subject: [PATCH 1/3] Initial plan From d29f423d2cfb1b1e76c138e8493cedfd00270410 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 6 Oct 2025 12:55:33 +0000 Subject: [PATCH 2/3] Improve README with clear sections for end users and developers Co-authored-by: Project516 <138796702+Project516@users.noreply.github.com> --- README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 55 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6bcaff6..fd84b58 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,61 @@ -# NumberGuessingGame +# Number Guessing Game -To run: Have at least Java 8 installed. +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. -## Development set up +## For End Users + +### Requirements + +- Java 8 or higher + +### How to Run + +**On Windows:** +Run `run.bat` + +**On Linux/Mac:** +Run `run.sh` or execute `java -jar app.jar` + +### How to Play + +1. Start the game using one of the methods above +2. Enter your guess when prompted +3. The game will tell you if your guess is too high or too low +4. Keep guessing until you find the correct number +5. The game will display how many guesses it took you + +## For Developers + +### Requirements + +- Java 8 or higher (Eclipse Temurin recommended) +- Gradle + +### Development Setup Install SDKMAN! and run: -`sdk install java 25-tem` +``` +sdk install java 25-tem +sdk install gradle +``` + +Or install Eclipse Temurin JDK directly from https://adoptium.net/ + +### Building + +``` +cd app +gradle build +``` + +### Running Tests + +``` +cd app +gradle test +``` + +### Creating Release Archive -`sdk install gradle` +Run `./package.sh` from the project root. This will create `archive.zip` containing the application and run scripts. From 8cba0d9cfbc686a444f6f6b048d213205d9177ec Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 6 Oct 2025 13:13:33 +0000 Subject: [PATCH 3/3] Address review feedback: improve section headers, clarify requirements, and expand build instructions Co-authored-by: Project516 <138796702+Project516@users.noreply.github.com> --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index fd84b58..0fb7122 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ 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. -## For End Users +## Running the Game ### Requirements -- Java 8 or higher +- Java 8 or higher (may require Java 17+ in future versions) ### How to Run @@ -24,26 +24,32 @@ Run `run.sh` or execute `java -jar app.jar` 4. Keep guessing until you find the correct number 5. The game will display how many guesses it took you -## For Developers +## Development ### Requirements -- Java 8 or higher (Eclipse Temurin recommended) +- Java 25 (Eclipse Temurin recommended for development) - Gradle ### Development Setup -Install SDKMAN! and run: +SDKMAN is the recommended way to install Java and Gradle (pre-installed in GitHub Codespaces): ``` sdk install java 25-tem sdk install gradle ``` -Or install Eclipse Temurin JDK directly from https://adoptium.net/ +Alternatively, install Eclipse Temurin JDK directly from https://adoptium.net/ ### Building +From the project root: +``` +gradle build +``` + +Or from the app directory: ``` cd app gradle build @@ -58,4 +64,4 @@ gradle test ### Creating Release Archive -Run `./package.sh` from the project root. This will create `archive.zip` containing the application and run scripts. +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.