Merge branch 'main' of https://github.com/Timmoth/iBlunder

README.md

@@ -2,12 +2,15 @@
 A strong dotnet UCI Chess engine 
 
 > [!NOTE]  
-> iBlunder is still in active development so will so expect certain features to be missing or experimental.
+> iBlunder is still in active development so will so expect certain features to be missing or experimental. Also the current release is using a NNUE net trained from self play starting with random weights and is only 6 iterations deep, expect the engine to be much stronger in the coming days as the training does takes a while.
 
 Play it here -> https://iblunder.com/
 
 Or challenge it on Lichess -> https://lichess.org/@/iblunder-bot
 
+## Releases
+You can download the latest version for windows, linux or mac [here](https://github.com/Timmoth/iBlunder/releases)
+
 ## Requirements
 - iBlunder makes use of hardware intrinsics to improve performance. Currently your CPU must support: `Avx2`, `Bmi1`, `Bmi2`, `Popcnt`, `Sse`. Most modern hardware shipped after 2013 should be supported.
 - The releases come with a bundled version of the dotnet runtime, however if you want to run from source you'll need the dotnet 8 SDK installed.
@@ -32,10 +35,58 @@ dotnet run --project .\iBlunder\iBlunder.csproj --configuration Release
 - `go eval` : [Dev] returns the static evaluation of the current position
 - `datagen` : [Dev] starts generating data in the bullet format, used when training a new NNUE network
 
+## Features
+
+<details>
+<Summary>General</Summary>
+
+- Bitboards 
+- NNUE 768->256
+- Transposition table
+- Lazy SMP
+- Pondering
+</details>
+
+<details>
+<Summary>Search</Summary>
+
+- Negamax
+- Quiescence
+- Alpha-Beta pruning
+- Iterative Deepening
+- Asperation windows
+- Null move pruning
+- Late Move Pruning
+- Futility Pruning
+- Razoring
+- Principal Variation Search
+- Check extensions
+- Internal Iterative Reduction
+- Late Move Reductions
+</details>
+
+<details>
+<Summary>Move generation / ordering</Summary>
+
+- Pseudo-legal movegen
+- Static exchange evaluation
+- Killer move heuristic
+- Counter move heuristic
+- History heuristic with malus
+- Incremental sorting
+- Magic bitboards
+- PEXT bitboards
+</details>
+
 ## SPRT
 After any changes to the engine a SPRT test must be ran to ensure that the changes have a positive effect.
 
 There is a script `sprt.bat` which contains the command to run a cutechess-cli SPRT test. Ensure that you've configured CuteChess to point to both `dev` and `base` engines before hand, and also update the opening book + endgame table base to point to one on your system.
 
 ## NNUE
-I'm in the process of training a 768->256 network starting from random weights using self play data generation and bullet trainer. Expect the engine to get much stronger in the coming days / weeks. Check [here](https://github.com/Timmoth/iBlunder/tree/main/iBlunder.Engine/Resources/WeightsHistory) to see the sequence of networks starting from scratch the training logs.
+I'm in the process of training a 768->256 network starting from random weights using self play data generation and bullet trainer. Expect the engine to get much stronger in the coming days / weeks. Check [here](https://github.com/Timmoth/iBlunder/tree/main/iBlunder.Engine/Resources/WeightsHistory) to see the sequence of networks starting from scratch and the training logs.
+
+## Resources:
+- [Chess Programming Wiki](https://www.chessprogramming.org/)
+- [Talk Chess Forum](https://talkchess.com/)
+- [Coding Adventure](https://www.youtube.com/watch?v=U4ogK0MIzqk)