docs: Add individual README.md to project folders missing them#952
Conversation
|
@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. |
There was a problem hiding this comment.
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 |
|
🎉 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! 🙌 |
Purpose
Fixes #872
This PR addresses the missing documentation issue by adding highly detailed, beautifully structured, and professional
README.mdfiles to the following three interactive Python games:games/Flipping-Tossgames/War-Card-Gamegames/Dots-Boxes-AISummary of Changes
1. 🪙 Flipping-Toss README
2. War-Card-Game README
3. Dots-Boxes-AI README