Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 62 additions & 6 deletions README.md
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
Copy link
Owner

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

Copy link
Contributor Author

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)

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.
Loading