Skip to content

Commit 5bdeb4a

Browse files
committed
clarify why someone might want to disable cache_game_state
1 parent 0b0cc5f commit 5bdeb4a

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ Check CHANGELOG.md for details - all breaking changes should be marked as *BREAK
181181
Some of the improvements made since the fork:
182182
- Build times are _drastically_ improved. rust-analyzer actually works now (thanks KarelPeeters)
183183
- Checking the `status` of the `Board` is 2-3x faster for a fully populated board (thanks AlexanderHarrison)
184-
- Using `Game` is 10-20x faster for reasonably sized games when using the new `cache_game_state` feature (more for larger games)
184+
- Using `Game` is 10-20x faster for reasonably sized games when using the new `cache_game_state` feature (more for larger games). If you're in an embedded environment and can't tolerate the extra kb of memory, you can disable this feature.
185185
- Legality checking of unsanitized moves is 4-5x faster
186186
- `Game::make_move` now returns `Option<String>` with the SAN representation of the move. `Board::make_move` still returns a bool to avoid overhead in the hot path
187187
- Optional instrumentation added to `Game`, using [tracing](https://github.com/tokio-rs/tracing) - just use the `instrument_game` feature.

0 commit comments

Comments
 (0)