From c0e8766fee9fe06a4af4a0c11daf0e7e9dfedc4d Mon Sep 17 00:00:00 2001
From: dogeystamp <dogeystamp@disroot.org>
Date: Sun, 3 Nov 2024 11:49:05 -0500
Subject: [PATCH] chore: README

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..47741a3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# chess-inator
+
+A chess engine.
+
+Features:
+- Negamax search
+- Alpha-beta pruning
+- Piece-square tables
+    - Tapered midgame-endgame evaluation
+- UCI compatibility
+
+## instructions
+
+To run the engine (in UCI mode):
+
+    cargo run --release
+
+Quick unit tests:
+
+    cargo test
+
+Longer duration, more rigorous tests:
+
+    cargo test --release
+
+Flamegraph (on perft):
+
+    export CARGO_PROFILE_RELEASE_DEBUG true
+    cargo flamegraph --test perft