1 files changed, 22 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..1bc638e
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,22 @@
+## cdoku
+
+this is a relativley simple and efficent sudoku puzzle brute force algorithm!
+
+check out ./example.sudoku and ./main.c for more documentation:)
+
+### building and running
+
+`just b` or `gcc -o cdoku main.c` to build the binary
+
+check out `just --list` for more options
+
+`cdoku {file path}`
+
+### examples and some bench marks
+
+1.60 GHz - ~0.169s
+
+### todo
+
+- read json formated
+- read sudoku as argument