Merge pull request #19 from VincentAuriau/doc

Documentation of main classes and functions to play a game
VincentAuriau · Oct 27, 2023 · f60e0d0 · f60e0d0
2 parents 6644ce5 + bf95966
commit f60e0d0
Show file tree

Hide file tree

Showing 6 changed files with 756 additions and 92 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 venv/
 .idea/
+.DS_Store
 __pycache__/
diff --git a/README.md b/README.md
@@ -1,4 +1,12 @@
+## PyAlapin, your customized chesse engine
+Is it the best, most efficient and state of the art chess engine ? I'm pretty sure not.
 
+However, driven by passion and madness, I have developed my own chess game in Python.
+For your pretty eyes and your devilish smile, I share it with you. But only with you.
+
+Special thanks and dedication to LeMerluche, crushing its opponents on chess.com with alapin openings ❤️
+
+## How to play with interface
 ```python
 from interface.interface import MyApp
 
@@ -9,7 +17,7 @@ if __name__ == '__main__':
 
 ![](interface_example.PNG)
 
-Python methods to play a game:
+## How to play with Python commands
 
 ```python
 import sys