Skip to content

Commit 9623659

Browse files
committed
Add installation guide and game controls
1 parent bf5e494 commit 9623659

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,24 @@ puzzl is an intelligent implementation of the classical sliding-puzzle game.
99

1010
It's built on top of Golang's *concurrency primitives*. It uses *goroutines* and *channels* for inter process communications to provide real time notification experience in unix terminals.
1111

12-
puzzl comes with an in-built solver(A* powered) which can solve any puzzle configuration faster than Iron Man. :zap:
13-
14-
![puzzl]()
12+
puzzl comes with an in-built solver which can solve any puzzle configuration faster than Iron Man. :zap:
13+
14+
![puzzl](https://github.com/pravj/puzzl/blob/development/puzzl.gif?raw=true)
15+
16+
####Installtion
17+
```go
18+
go get github.com/pravj/puzzl
19+
```
20+
* Make sure that the workspace's **bin** directory is added to your **PATH**
21+
```go
22+
export PATH=$PATH:$GOPATH/bin
23+
```
24+
25+
####Controls
26+
* Start the game with the command *puzzl*.
27+
* Use Arrow Keys to move the blank tile wherever you want.
28+
* Press 'h' or 'H' to get any hint for next move.
29+
* Press ESC key to quit the game.
1530

1631
---
1732

0 commit comments

Comments
 (0)