diff --git a/card_game/README.md b/card_game/README.md new file mode 100644 index 0000000..44cfd8f --- /dev/null +++ b/card_game/README.md @@ -0,0 +1,32 @@ +Card Game +========= + +`card_game` is a library to implement card games. Mainly interesting for the `Game` trait and the `Session` type. + +## Example + +```rust +use card_game::{Card, Deck, Rank, Stack, Suit}; + +// create a full deck (unshuffled) +let mut deck = Stack::full_deck(Deck::Deck1); + +// inspect the top card +let card = deck.pop().unwrap(); +assert_eq!(card, Card::new(Deck::Deck1, Suit::Diamonds, Rank::King)); +``` + +#### License + + +Licensed under either of Apache License, Version +2.0 or MIT license at your option. + + +
+ + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in this crate by you, as defined in the Apache-2.0 license, shall +be dual licensed as above, without any additional terms or conditions. +