README.md

py-golf

Simulation of golf games

Explore the latest docs »

---

hic sunt dracones

Please don't depend on this package as it is being used to test out a migration.

You have been warned.

If you play golf, you'll know what this is doing. Use at your own risk.

This is a tiny library in a much larger one.

---

✨ Features

• Ability to avoid kill screens
• Hic Sunt Pokémon
• Speaks mystical incantations when errors are encountered

🚀 Getting Started

Prerequisites

• uv

curl -LsSf https://astral.sh/uv/install.sh | sh

Installation

1. Clone the repo

git clone https://github.com/ryankanno/py-golf-games.git

2. Install

uv sync --locked

🛠️ Usage

Running the simulation

./simulate.sh

For more examples, please refer to the documentation

🚧 Roadmap

See the open issues for a list of proposed features (and known issues).

☑️ TODO

• TODO 1

🤝 Contributing

Contributions are very much appreciated.

1. Fork the project
2. Create your feature branch (git checkout -b feature/new-py-golf-games-feature)
3. Commit your changes (git commit -m 'Added a new feature to py-golf-games')
4. Push to the feature branch (git push origin feature/new-py-golf-games-feature)
5. Open a PR! 🎆

📝 License

Distributed under the MIT License. See LICENSE for more information.

📫 Contact

Ryan Kanno

Project Link: https://github.com/ryankanno/py-golf-games

🙏 Acknowledgements

Anyone you'd like to thank?