diff --git a/README.md b/README.md new file mode 100644 index 0000000..7e17fc7 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Rust Sokoban + +Based on [https://sokoban.iolivia.me/](https://sokoban.iolivia.me/) + +## Dependencies +On linux libudev and libalsasound2 likely need to be installed: + +(On Debian/Ubuntu) `sudo apt-get install libudev-dev libasound2-dev` + +## Running +* `cargo run` does a dev build and runs +* `cargo run --release` does a release build and runs \ No newline at end of file