Fortune Cookie Simulator

Virtual fortune cookie simulator in ASCII and terminal text format
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Crack open some virtual fortune cookies with my Python script here! Feel free to create your own customised list of fortunes into a .csv file. I have included an example csv file in the repo so you can use it right away if you prefer.

Screenshots

Built With

• Python 3.9.0

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Have Python 3 installed on your device.

Installation

1. Clone the repo

   git clone https://github.com/Julian97/fortune-cookie-simulator.git

Usage

1. Download my example csv file, which contains a list of fortunes to draw from.
2. Change the filepath in line 6 (see screenshot).
3. Run the code.
4. Follow on-screen instructions.

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the BSD 2-Clause "Simplified" License. See LICENSE for more information.

Contact

Julian Cheung - @cyan39miku - juliancheung97@gmail.com

Project Link: https://github.com/Julian97/fortune-cookie-simulator

Acknowledgements

• StackOverflow
• othneildrew