Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
Iipin committed Dec 21, 2019
1 parent b9a7a09 commit 5f64325
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Usage

The only command provided is `\DrawHand{height}{description}`, where `height` is the target height of the resulting TikZ figure and `description` is the hand description in following format:
The only command provided is `\DrawHand{description}{height}`, where `height` is the target height of the resulting TikZ figure and `description` is the hand description in following format:

- Any of the `mpsz` changes the current tile color,
- Any of the `mpsz` changes the current tile suite,
- Any of the `0123456789` (for `mps`), `1234567` (for `z`) or `?` draws a tile. If a `*` follows, the tile is drawn rotated. `0` means red five and `?` means tile back,
- `~` makes space of length equal to 0.5 of tile's width.

Putting number before current color is specified or including any other characters in description results in undefined behavior.
Putting number before first suite is specified or including any other characters in description results in undefined behavior.

Tile images are created by FluffyStuff, available under [https://github.com/FluffyStuff/riichi-mahjong-tiles](https://github.com/FluffyStuff/riichi-mahjong-tiles) and licensed under [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/).
Tile images are created by FluffyStuff, available under [https://github.com/FluffyStuff/riichi-mahjong-tiles](https://github.com/FluffyStuff/riichi-mahjong-tiles) and licensed under [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/).

0 comments on commit 5f64325

Please sign in to comment.