joker/doc.go

28 lines
519 B
Go

/*
Package cards provides playing cards.
Cards
To initialize a card:
card := Card{FaceAce, SuitSpades}
To sort a set of cards:
hand := Cards{
Card{FaceAce, SuitSpades},
Card{Face3, SuitSpades},
Card{Face2, SuitSpades}
}
sort.Sort(hand)
Deck
To initialize a deck, call NewDeck with a seed for the random number generator
used when shuffling. A seed value of zero will be replaced with the
current unix time in nanoseconds.
deck := NewDeck(StandardCards, 0)
*/
package cards