1 files changed, 58 insertions(+), 12 deletions(-)

M README.md

@@ 1,17 1,63 @@
-# CowChina [![Travis](https://img.shields.io/travis/hmksq/CowChina.svg)]() [![Coveralls](https://img.shields.io/coveralls/hmksq/CowChina.svg)]()
-CowChina is a logger for a variant of the Spades playing card game. It logs the moves, invalid cards (cheating) and winners. It is licensed under the MIT License.  
-Right now, this could only be used with our variant of Spades, called Hokm.  
+# CowChina
 
-## Hokm
-There are four players, each player is the partner with the player in front of them. The game and deals go anti-clockwise.  
-A deck of 52 cards is used, listed from highest to lowest: Big (red) Joker, Small (black) Joker, A, K, Q, J, 10, 9, 8, 7, 6. Other cards are not included. Each player will have 9 cards.  
-Bidding usually has a minimum of 6, the highest bidder will choose the Hokm (suit).  
-The rest of the game is like Spades, but the suit will be chosen by the highest bidder than being default to spades.  
+## 1. Description
+CowChina is a logger for a variant of the Spades playing card game. It logs the moves, invalid cards (cheating) and winners.  
 
-## How to run
+This could only be used with our variant of Spades, called Hokm.  
+
+## 2. Requirements
+
+The following packages must be installed on your system.
+
+- Go
+- Git
+
+## 3. Copying and contributing
+
+This program is written by Humaid AlQassimi, and is distributed
+under the [MIT](https://humaidq.ae/license/mit) license.  
+
+
+## 4. Download and install
+
+```sh
+$ go get -u git.sr.ht/~humaid/cowchina
+$ go install git.sr.ht/~humaid/cowchina
 ```
-go run cowchina.go
+
+## 5. Usage
+
+To run the program:
+```sh
+$ cowchina
 ```
 
-## Contributing
-We appreciate your contributions! Make sure your code is run through `golint` before commiting.
+To begin, the names of the four players, the
+highest bid, bidding suit chosen, and highest bidding team is
+entered.  
+
+Then the each card is inputed. Below is a cheat sheet of possible
+inputs.
+
+### 5.1. Input cheat sheet
+
+| Input | Description |
+| ---- | ----- |
+| `ca` | Ace of Clubs |
+| `da` | Ace of Diamonds |
+| `ha` | Ace of Hearts |
+| `sa` | Ace of Spades |
+| `c{6-9}` | Clubs 6 to 9 |
+| `s{6-9}` | Diamonds 6 to 9 |
+| `h{6-9}` | Hearts 6 to 9 |
+| `s{6-9}` | Spades 6 to 9 |
+| `c{j,q,k}` | Clubs {jack, queen, king} |
+| `d{j,q,k}` | Diamonds {jack, queen, king} |
+| `h{j,q,k}` | Hearts {jack, queen, king} |
+| `s{j,q,k}` | Spades {jack, queen, king} |
+| `z` | Black Joker |
+| `x` | Red Joker |
+| `{enter}` | PASS |
+| `{tab}` | Go back **(TODO)** |
+| `:<id>` | Jump to player **(TODO)** |
+