https://github.com/lordksix/tic-tac-toe-python
This is a tic tac toe game using python
https://github.com/lordksix/tic-tac-toe-python
Last synced: about 2 months ago
JSON representation
This is a tic tac toe game using python
- Host: GitHub
- URL: https://github.com/lordksix/tic-tac-toe-python
- Owner: lordksix
- License: gpl-3.0
- Created: 2023-08-24T07:04:22.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-08-27T23:46:40.000Z (almost 2 years ago)
- Last Synced: 2024-05-17T15:48:28.648Z (about 1 year ago)
- Language: Python
- Homepage: https://lordksix.github.io/tic-tac-toe-python/
- Size: 1.03 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Tic Tac Toe by Python
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
**Tic Tac Toe by Python** is a console game application. This application runs on python the user can selection between different of 2 levels of computer AI. It is wrapped in a PIP package.
Programming Language
- **Separation of responsabilities**
- **Minimax algorithmm implemented as basic AI**
- **Implement CLI commands**
- **Docstrings and docpage implement - Google standard and MkDocs**
### Prerequisites
In order to run this project you need:
- To clone or fork this repo
- Python installed in your machine
- It is recommended to use a virtual environment
For more information on how to install ruby on your machine:
- How to install Python
### Setup
Clone this repository to your desired folder:
For example, using Ubuntu:
```sh
cd my-desired-folder
git clone https://github.com/lordksix/tic-tac-toe-python
```
For more information on how to clone or fork a repository:
- How to clone a repo
- How to fork a repo
### Install
To install dependencies, the following command must be run in the terminal:
```sh
cd tic-tac-toe-python
python -m pip install tic-tac-toe
```
### Usage
In the project directory, you can run:
```sh
tictactoe
```
For further informacion read the [docs](https://lordksix.github.io/tic-tac-toe-python/)
Game UI
### Run tests
Tests to be implemented
👤 **lordksix**
- GitHub: [@lordksix](https://github.com/lordksix)
- LinkedIn: [@wladpasquel](https://www.linkedin.com/in/wladpasquel/)
- Medium: [@wladimir.pasquel](https://medium.com/@wladimir.pasquel)
Future changes:
- Implementation of tests
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, I encourage you to clone, fork and contribute. Our community and knowledge grows with each engagement.
I want to thank RealPython for the help, base and inspiration.
- **Do I need a IDE or a special text editor to make changes?**
- No, you don't. You can use NotePad to make changes.
This project is [GNU v3](./LICENSE) licensed.