-
Notifications
You must be signed in to change notification settings - Fork 0
Improve README with clear sections for end users and developers #32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Project516
merged 3 commits into
master
from
copilot/fix-55ee7f3d-f4cf-488e-80ad-15872119adb3
Oct 6, 2025
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,67 @@ | ||
| # 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 | ||
| ## Running the Game | ||
|
|
||
| Install SDKMAN! and run: | ||
| ### Requirements | ||
|
|
||
| `sdk install java 25-tem` | ||
| - Java 8 or higher (may require Java 17+ in future versions) | ||
|
|
||
| `sdk install gradle` | ||
| ### 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 | ||
|
|
||
| ## Development | ||
|
|
||
| ### Requirements | ||
|
|
||
| - Java 25 (Eclipse Temurin recommended for development) | ||
| - Gradle | ||
|
|
||
| ### Development Setup | ||
|
|
||
| SDKMAN is the recommended way to install Java and Gradle (pre-installed in GitHub Codespaces): | ||
|
|
||
| ``` | ||
| sdk install java 25-tem | ||
| sdk install gradle | ||
| ``` | ||
|
|
||
| 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 | ||
| ``` | ||
|
|
||
| ### Running Tests | ||
|
|
||
| ``` | ||
| cd app | ||
| gradle test | ||
| ``` | ||
|
|
||
| ### Creating Release Archive | ||
|
|
||
| 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. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can build from root too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added build instructions showing both options - from project root and from app directory. (commit d29f423)