Add docs structure

Duzzuti · Dec 27, 2023 · f09937e · f09937e
1 parent 89f446e
commit f09937e
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,14 @@
 # poker-workshop
+This is a playground for poker.
+The goal is to create a poker game that can be played by multiple computer players.
+
+There are multiple objectives for this project:
+- simulate a poker game
+- create a poker file format to save games and states
+- create poker AIs with different strategies and play them against each other
+- create an environment to train poker AIs
+- create an API to allow anybody to create their own poker AIs
+
 ## Development environment
 In order to ensure that all developers use the same environment, we use docker. This will avoid many problems with different versions of libraries and compilers. We will carry out the development using VSCode's Remote Development extension. This will allow us to do all our coding, compiling and testing inside a docker container.
 
@@ -23,3 +33,4 @@ If you are not using VSCode, you need to skip step 2 and instead of steps 5-8, y
 1. Right click on the `poker-workshop` container and click `Attach to container`
 1. Install the required extensions in the container (C/C++, CMake)
 
+## Docs
diff --git a/docs/deck.md b/docs/deck.md
diff --git a/docs/game.md b/docs/game.md
diff --git a/docs/handstrengths.md b/docs/handstrengths.md
diff --git a/docs/player.md b/docs/player.md
diff --git a/docs/players.md b/docs/players.md