Skip to content

Commit

Permalink
Document the existence of cargo features.
Browse files Browse the repository at this point in the history
  • Loading branch information
KarelPeeters committed Mar 26, 2024
1 parent a1a2466 commit 7310e69
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
5 changes: 5 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,9 @@ let mut bot = MCTSBot::new(1000, 2.0, thread_rng());
println!("{:?}", bot.select_move(&board))
```

### Cargo features

Each game has a separate cargo feature, and there's a `game_all` default feature that enables all games.
See [the docs](https://docs.rs/crate/board-game/latest/features) for a full list.

<!-- cargo-rdme end -->
6 changes: 5 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,16 @@
//! println!("{:?}", bot.select_move(&board))
//! # }
//! ```
//!
//! ## Cargo features
//!
//! Each game has a separate cargo feature, and there's a `game_all` default feature that enables all games.
//! See [the docs](https://docs.rs/crate/board-game/latest/features) for a full list.
// export used game crates

#[cfg(feature = "game_arimaa")]
pub use arimaa_engine_step;

#[cfg(feature = "game_chess")]
pub use chess;

Expand Down

0 comments on commit 7310e69

Please sign in to comment.