From afc7c56df08c3d03999c5e8f736c61d139cf8e65 Mon Sep 17 00:00:00 2001 From: Arlin Schaffel Date: Sun, 4 Feb 2024 14:08:10 -0600 Subject: [PATCH] Create basic README - lists license as GNU GPL v3.0 but still needs to be added --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a909620..f64e5aa 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ # Puzzle ♟ Chess -A basic chess game where you solve puzzles, built with HTML / CSS / JavaScript. + +A simple chess game where you solve puzzles. + +## ðŸ’ŧ Technology + +Built with basic HTML, CSS, and JavaScript. + +## ðŸŠķ Philosophy + +I try to write code that beginners can understand. Keep everything simple. Avoid being overly complex or caring too much about optimization. + +## ðŸĪ Attribution + +- Pieces by [Cburnett](https://en.wikipedia.org/wiki/User:Cburnett), [CC BY-SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/) via [Wikimedia Commons](https://commons.wikimedia.org/wiki/Template:SVG_chess_pieces) +- Puzzles via [Lichess Open Database](https://database.lichess.org/#puzzles), [Creative Commons CC0](https://www.tldrlegal.com/license/creative-commons-cc0-1-0-universal) +- Uses [fen-validator](https://github.com/jayasurian123/fen-validator), [GNU GPL v3.0](https://choosealicense.com/licenses/gpl-3.0/) by [Jayasurian Makkoth](https://github.com/jayasurian123) +- Uses [JS-CHESS-ENGINE](https://github.com/josefjadrny/js-chess-engine), [MIT](https://choosealicense.com/licenses/mit/) by [Josef Jadrny](https://github.com/josefjadrny) + +## 📜 License + +Copyright (c) 2024 Arlin Schaffel + +Licensed under the **GNU GPL v3.0 License**, available here: https://github.com/FeXd/puzzle-chess/blob/main/LICENSE.md