Skip to content

Latest commit

 

History

History
104 lines (67 loc) · 2.22 KB

README.md

File metadata and controls

104 lines (67 loc) · 2.22 KB
Raw

PyRPS Logo

Instantly play rock-paper-scissors with a simple CLI interface ⚔️

Description

🧐 About • ✨ Features • 🛠️ Installation • 🚀 Usage • 🤝 Contributing • 📄 License • 📫 Contact

🧐 About

PyRPS is a straightforward command-line interface (CLI) game for playing rock-paper-scissors. It’s built in Python and designed for quick, casual gameplay. Whether you’re looking to kill some time or practice Python scripting, PyRPS offers a fun and simple experience.

✨ Features

  • Simple CLI Interface: Play rock-paper-scissors directly in your terminal.

  • Lightweight: Minimal dependencies make it quick and easy to run.

  • Cross-Platform: Works on Windows, MacOS & Linux!

🛠️ Installation

PyRPS can be installed via pip! However, make sure that you have Python version 3.11 or greater installed in your system.

  • For Windows
pip install ayrun-pyrps
  • For MacOS & Linux
pip3 install ayrun-pyrps

🚀 Usage

After installing, run the rps command in your console to run PyRPS!

rps

🤝 Contributing

Contributions are welcome! Please follow these steps to contribute:

  1. Fork the project

  2. Create a new branch

git checkout -b feature/YourFeature
  1. Commit your changes
git commit -m "Add YourFeature"
  1. Push to the branch
git push origin feature/YourFeature
  1. Open a Pull Request( PR )

Please make sure your code is well-documented and follows the project's coding style.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

📫 Contact

For any questions or suggestions, feel free to reach out: