Skip to content

docs: Add individual README.md to project folders missing them#952

Merged
steam-bell-92 merged 1 commit into
steam-bell-92:mainfrom
nishtha-agarwal-211:docs/872-add-readmes
Jun 2, 2026
Merged

docs: Add individual README.md to project folders missing them#952
steam-bell-92 merged 1 commit into
steam-bell-92:mainfrom
nishtha-agarwal-211:docs/872-add-readmes

Conversation

@nishtha-agarwal-211
Copy link
Copy Markdown
Contributor

Purpose

Fixes #872

This PR addresses the missing documentation issue by adding highly detailed, beautifully structured, and professional README.md files to the following three interactive Python games:

  1. games/Flipping-Toss
  2. games/War-Card-Game
  3. games/Dots-Boxes-AI

Summary of Changes

1. 🪙 Flipping-Toss README

  • Features List: Documented interactive coin tossing, user prediction capability, simulated time delays, and input validation.
  • Detailed Statistics Tracking: Highlighted how the game summarizes total tosses, heads/tails ratio, and prediction accuracy.
  • Gameplay Guide & Sample Output: Added visual CLI examples of running the game, making predictions, and reading summaries.

2. War-Card-Game README

  • Features List: Documented multi-player configuration, programmatic 52-card standard deck creation, shuffling mechanism, and interactive round continuation.
  • Rules & Gameplay Guide: Detailed card comparisons, tie scenarios, scoring systems, and the game replay option.
  • Sample Output: Included real-time game flows showcasing custom players Nishtha and Antigravity battling it out.

3. Dots-Boxes-AI README

  • Features List: Outlined the advanced ANSI color styling, custom grid rendering, dynamic board dimensions (from 2x2 up to 8x8), and the double turn scoring mechanism.
  • AI Heuristics Breakdown: Described the game modes (PvP & PvE) and provided a detailed breakdown of the three difficulty levels:
    • 🟢 Easy: Random selections.
    • 🟡 Intermediate: Basic completion & threat denial.
    • 🔴 Hard: Sophisticated heuristic scoring analyzing overall boards.
  • Usage Guide: Provided input formats and an illustrative terminal board render to guide first-time players.

Copilot AI review requested due to automatic review settings June 2, 2026 14:02
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 2, 2026

@nishtha-agarwal-211 is attempting to deploy a commit to the Anuj's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds end-user documentation (READMEs) for three Python CLI games to explain features, requirements, and how to run them.

Changes:

  • Added a README for the War Card Game with gameplay guide and sample output.
  • Added a README for the Flipping Toss (coin flip) game with stats summary and sample output.
  • Added a README for the Dots & Boxes AI game covering modes, AI difficulty, and controls.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File Description
games/War-Card-Game/README.md New usage + feature documentation for War Card Game.
games/Flipping-Toss/README.md New usage + feature documentation for Flipping Toss game.
games/Dots-Boxes-AI/README.md New usage + feature documentation for Dots & Boxes AI.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


## 🚀 Features

- 👥 **Multiplayer Experience**: Supports custom player names (or defaults to Player 1 and Player 2).
@@ -0,0 +1,96 @@
# 🪙 Coin Flip Game (Flipping Toss)

A simple, interactive, and beginner-friendly command-line game written in Python where players can toss a coin, predict the outcome (Heads or Tails), and track their prediction accuracy with detailed real-time statistics.
```
2. Run the script:
```bash
python War-Card-Game.py
```
2. Run the script:
```bash
python Flipping-Toss.py
```
2. Run the script:
```bash
python Dots-Boxes-AI.py
@steam-bell-92 steam-bell-92 merged commit dea1135 into steam-bell-92:main Jun 2, 2026
9 of 10 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

🎉 Thank you for your contribution!

Your Pull Request has been merged successfully.

We appreciate the time and effort you put into improving this project. Contributions like yours help the repository grow and stay useful for everyone.

If you'd like to contribute again, please check the open issues and make sure you are assigned before opening another Pull Request.

Thanks again for your support! 🙌

@nishtha-agarwal-211 nishtha-agarwal-211 deleted the docs/872-add-readmes branch June 3, 2026 11:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gssoc:approved level:beginner type:docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Add individual README.md to projects missing them

3 participants