Skip to content

Commit

Permalink
Upgrade the README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
jesusgraterol committed Nov 30, 2023
1 parent ccdbe01 commit de166d4
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 8 deletions.
119 changes: 111 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,117 @@
# Tic Tac Toe Project
# Tic Tac Toe

This repository implements [The Odin Project's](https://www.theodinproject.com/) Tic Tac Tow
Project with Vanilla CSS & JavaScript. For more information about this project, please visit:
![Tic Tac Toe](./readme-assets/screenshot-01.png)

[https://www.theodinproject.com/lessons/node-path-javascript-tic-tac-toe](https://www.theodinproject.com/lessons/node-path-javascript-tic-tac-toe)
This application allows the user to draw anything on a canvas with the mouse and it is the submission for [The Odin Project: Tic Tac Toe](https://www.theodinproject.com/lessons/node-path-javascript-tic-tac-toe). The key features are:

A live demo of this solution can be accessed here:
- Any number of games can be played
- The computer is an implementation of the Minimax algorithm
- Cross-Platform Compatibility

[https://jesusgraterol.github.io/tictactoe_top/](https://jesusgraterol.github.io/tictactoe_top/)

A local instance can be served with:

`python3 -m http.server`


## Live Demo

[Tic Tac Toe](https://jesusgraterol.github.io/tictactoe-top/)





## Getting Started

### Requirements

- GIT
- Python ^v3

### Installation

1) Clone the repository
```bash
git clone git@github.com:jesusgraterol/tictactoe-top.git
```





## Usage

1) Run a local server with:

```bash
python3 -m http.server
```

2) Access the app through: [http://localhost:8000/](http://localhost:8000/)





## Build Process

N/A





## Deployment

Deploys to **Github Pages** automatically when commits are pushed into the `main` branch.






## Built With

- HTML5
- CSS3
- JavaScript





## Running the Tests

```bash
# Unit Tests
N/A

# Integration Tests
N/A

# E2E Tests
N/A
```





## @TODO

N/A





## License

[MIT](https://choosealicense.com/licenses/mit/)





## Acknowledgments

- [Google Fonts](https://fonts.google.com/icons)
Binary file added readme-assets/screenshot-01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit de166d4

Please sign in to comment.