Skip to content

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.

Sign up for GitHub

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

Jump to bottom
Merged
Project516 merged 3 commits into from
Oct 6, 2025
Merged

Improve README with clear sections for end users and developers #32

Project516 merged 3 commits into from
Oct 6, 2025

Conversation

Copy link
Contributor

Copilot AI commented Oct 6, 2025 •
edited
Loading

  • Review current README and identify improvements needed
  • Update README with clear sections for end users and developers
  • Add section describing the game
  • Add clear instructions for end users (Java 8+ requirement, how to run)
  • Add comprehensive development setup with Eclipse Temurin recommendation
  • Ensure no emojis are used and content is concise
  • Test that the updated README is clear and helpful
  • Verify README gets copied correctly to release archive
  • Address review feedback: improve section wording and clarify requirements
  • Update "For End Users" to "Running the Game"
  • Update "For Developers" to "Development"
  • Add note about potential Java 17+ requirement in future
  • Clarify Java 25 is for development
  • Emphasize SDKMAN as recommended (pre-installed in GitHub Codespaces)
  • Add build instructions from project root
  • Update archive description to mention GitHub Releases
Original prompt

The readme file gets copied over to the archive that gets released (see the package.sh file) Help improve the readme file for both devs and the end user. Do not use any emojis and keep it concise. The recommeded java vender is eclipse termium. For the end user the min of java 8 is required

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@Project516
Improve README with clear sections for end users and developers
d29f423 
Co-authored-by: Project516 <138796702+Project516@users.noreply.github.com>
Copilot AI changed the title The readme file gets copied over to the archive that gets released (see the package.sh file) Help improve the readme file for both devs and the end user. Do not use any emojis and keep it concise. The recommeded java vender is eclipse termium. For the ... Improve README with clear sections for end users and developers Oct 6, 2025
Copilot AI requested a review from Project516 October 6, 2025 12:56
Project516
Project516 requested changes Oct 6, 2025
View reviewed changes
Copy link
Owner

@Project516 Project516 left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, thank you for saving me time

@copilot

README.md Outdated
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
Copy link
Owner

@Project516 Project516 Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe word this better?

Copy link
Contributor Author

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed "For End Users" to "Running the Game" for clearer wording. (commit d29f423)

README.md Outdated

### Requirements

- Java 8 or higher
Copy link
Owner

@Project516 Project516 Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we may move to java 17 as the min for junit

Copy link
Contributor Author

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added note about potential Java 17+ requirement: "Java 8 or higher (may require Java 17+ in future versions)". (commit d29f423)

README.md Outdated
4. Keep guessing until you find the correct number
5. The game will display how many guesses it took you

## For Developers
Copy link
Owner

@Project516 Project516 Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about change the wording for To develop or something

Copy link
Contributor Author

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed "For Developers" to "Development". (commit d29f423)

README.md Outdated

### Requirements

- Java 8 or higher (Eclipse Temurin recommended)
Copy link
Owner

@Project516 Project516 Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its java 25 to dev

Copy link
Contributor Author

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to clarify "Java 25 (Eclipse Temurin recommended for development)". (commit d29f423)

README.md Outdated

### Development Setup

Install SDKMAN! and run:
Copy link
Owner

@Project516 Project516 Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the recommened version (especily in gh codspaces

Copy link
Owner

@Project516 Project516 Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SDKMAN is pre installed in gh codespaces btw

Copy link
Contributor Author

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to emphasize SDKMAN as recommended: "SDKMAN is the recommended way to install Java and Gradle (pre-installed in GitHub Codespaces)". (commit d29f423)

README.md Outdated
sdk install gradle
```

Or install Eclipse Temurin JDK directly from https://adoptium.net/
Copy link
Owner

@Project516 Project516 Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

README.md
### Building

```
cd app
Copy link
Owner

@Project516 Project516 Oct 6, 2025

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

Copilot AI Oct 6, 2025

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)

README.md Outdated
### Creating Release Archive

`sdk install gradle`
Run `./package.sh` from the project root. This will create `archive.zip` containing the application and run scripts.
Copy link
Owner

@Project516 Project516 Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And copy the readme over too. This can be released to gh releases

Copy link
Contributor Author

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to: "This will create archive.zip containing the application, run scripts, and README. The archive can be released to GitHub Releases." (commit d29f423)

@Project516
Copy link
Owner

Project516 commented Oct 6, 2025

@copilot

@Project516
Copy link
Owner

Project516 commented Oct 6, 2025

@copilot look at my feedback

@Project516
Address review feedback: improve section headers, clarify requirement…
8cba0d9 
…s, and expand build instructions

Co-authored-by: Project516 <138796702+Project516@users.noreply.github.com>
Copilot AI requested a review from Project516 October 6, 2025 13:14
Copy link
Contributor Author

Copilot AI commented Oct 6, 2025

@copilot look at my feedback

I've reviewed and addressed all the feedback in commit 8cba0d9:

  • Changed "For End Users" to "Running the Game"
  • Changed "For Developers" to "Development"
  • Added note about potential Java 17+ requirement
  • Clarified Java 25 is for development
  • Emphasized SDKMAN as recommended (pre-installed in GitHub Codespaces)
  • Added build instructions from project root
  • Updated archive description to mention GitHub Releases and README inclusion

@Project516 Project516 marked this pull request as ready for review October 6, 2025 13:20
@Project516 Project516 merged commit 55c4548 into master Oct 6, 2025
2 checks passed
@Project516 Project516 deleted the copilot/fix-55ee7f3d-f4cf-488e-80ad-15872119adb3 branch October 6, 2025 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@Project516 Project516 Project516 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@Project516 Project516

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Project516