docs: Add README file

This commit is contained in:
sigmasternchen 2024-11-02 17:06:38 +01:00
parent 73be2de2ca
commit ab4d00cfe2
2 changed files with 27 additions and 1 deletions

1
.python-version Normal file
View file

@ -0,0 +1 @@
3.12

View file

@ -1 +1,26 @@
# html-tictactoe
# Tic-Tac-Toe in HTML
## Yes, really.
This is my version of Tic-tac-toe with all the game state encoded in the URL.
If you want to know more about how this works in theory, check out my
[blog post](https://blog.sigma-star.io/2024/11/tic-tac-toe-in-html/) on the topic.
### But... why?
It's fun.
### Why are there Python files?
Since I'm not writing 443 HTML files by hand I wrote a script to generate them.
## How to run?
You'll need Python 3.12 and Poetry.
```bash
poetry install
poetry run python -m generator
```
The generated HTML files are stored in the output/ directory.