From bdef8b8ab2636b01907f2f7e94c2515f8421d43a Mon Sep 17 00:00:00 2001 From: Patrick Evans Date: Sun, 16 Aug 2020 15:10:28 +1200 Subject: [PATCH] :pencil: Updated README.md --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7d9631d..ca665d5 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,27 @@ Fire in the terminal using unicode characters. -Based on +Based on: -- https://github.com/r-marques/doomfire/ (doomfire implementation) -- https://github.com/yazgoo/blockish (image rendering in the terminal) +- [r-marques/doomfire](https://github.com/r-marques/doomfire/) (doomfire implementation) +- [yazgoo/blockish](https://github.com/yazgoo/blockish) (image rendering in the terminal) -# downloading +## Downloading -binary version available in [releases page](https://github.com/yazgoo/blockishfire/releases) +Binary version available in [releases page](https://github.com/yazgoo/blockishfire/releases) -# running +## Running +Initialize Git modules: + +```bash +git submodule update --init +``` + +Build and run: + +```bash cargo run --release +``` + +---