@@ 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