hangman_gui

Table of Contents

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

About The Project

This project was inspired by the cli based hangman game. I recently learnt how to use the PySimpleGUI python library and decided to give the game a face

(back to top)

Built With

Thanks to the following amazing packages for making this application a reality.

• PySimpleGUI

(back to top)

Getting Started

The steps below explains how you can get this awesome game up and running. Follow the steps as-is.

Prerequisites

All requirements are in the requirements.txt file

• pip

  pip install PySimpleGUI

Installation

1. Clone the repo

   git clone https://github.com/your_username_/hangman_gui.git

2. cd into the app folder

   cd ./hangman_gui

3. Install Python package

   pip install -r requirements.txt

(back to top)

Usage

To play this game, after installing PySimpleGUI just run python game.py.

Data Cleaning

Take a look inside the ./dic_data_cleaning directory to see how the dictionary data was cleaned and added to the database

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

Your Name - @hyelnatz2 - hndzarma@gmail.com

Project Link: https://github.com/hyelnatzz/hangman_gui

(back to top)