From 8ac7794cab2ee10adb7d1a4b107039063f3fabc7 Mon Sep 17 00:00:00 2001 From: Jakob Meier Date: Sat, 25 Feb 2023 14:47:19 +0100 Subject: [PATCH] Added basic build instructions --- README.org | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.org b/README.org index 512be9a..b0f47e3 100644 --- a/README.org +++ b/README.org @@ -1,8 +1,30 @@ +[[./logo.png]] + * Little Town -Build a small isometric town. +Design your own isometric world, +build a town or a castle, +with this 2D game + +** Building +*** Requirements +- cargo +- rustup +*** Steps +1. Install rust using [[https://www.rust-lang.org/tools/install][rustup]] +2. Clone this repo: + #+begin_src bash + git clone https://codeberg.org/comcloudway/little_town + + cd little_town + #+end_src +3. Build the binary using cargo: + #+begin_src bash + cargo build --release + #+end_src +4. The output binary can be found in the ~target~ folder. ** Credits -The Assets were created by [[][Kenney]] +The Assets were created by [[https://kenney.nl/][Kenney]] and are licensed under [[https://creativecommons.org/publicdomain/zero/1.0/][CC0 1.0 Universal]]. See below or a detailed list: - [[https://kenney.nl/assets/sketch-town][Sketch Town]] assets pack -- 2.38.5