diff --git a/README.md b/README.md index 64690cd..3dd397b 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,29 @@ rust-2048 ========= A 2048 clone with Piston game engine + +Dependencies +------------ +| Dependency | Online Docs | +|---------|------|------------| +| [rust-graphics](https://github.com/PistonDevelopers/rust-graphics) | [rust-graphics docs](http://pistondevelopers.github.io/docs/rust-graphics/graphics/) | +| [piston](https://github.com/PistonDevelopers/piston) | [piston docs](http://bvssvni.github.io/docs/piston/piston/) | + + +How to play +----------- +Use array key to move tiles. + +![alt tag](./rust-2048.png) + +Building Instructions +--------------------- + +Add the dependencies and add the '.rlib' files to '/target/cpu-vendor-os/lib/': + +In the Terminal window, navigate to the project folder and type: + +``` +make run +``` +