From 6606c60dfa9d17f713d58fc5743c589ca447e613 Mon Sep 17 00:00:00 2001
From: Wouter Wijsman <wwijsman@live.nl>
Date: Tue, 7 Jun 2022 09:35:01 +0200
Subject: [PATCH] Add BUILDING.md

---
 BUILDING.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 BUILDING.md

diff --git a/BUILDING.md b/BUILDING.md
new file mode 100644
index 0000000..20a354c
--- /dev/null
+++ b/BUILDING.md
@@ -0,0 +1,61 @@
+# Building
+
+This document contains information on how to build Laser Kombat for each supported platform.
+
+## Ubuntu
+
+On Ubuntu install the required packages with the following command:
+
+```
+sudo apt-get install git cmake build-essential pkgconf libsdl2-dev libsdl2-ttf-dev
+```
+
+clone the git repository (to get the code):
+```
+git clone https://github.com/sharkwouter/laserkombat.git
+```
+
+To build execute the following commands from a terminal in the directory where the code is found:
+
+```
+mkdir build
+cd build
+cmake ..
+make
+```
+
+Then the game can be started with:
+
+```
+./laserkombat
+```
+
+The executable should be found in ``~/laserkombat/build``.
+
+## Windows
+
+On Windows first download and install [msys2](https://www.msys2.org/). Then start the MinGW64 terminal and install the following packages with it:
+
+```
+pacman -Syu git mingw-w64-x86_64-gcc mingw-w64-x86_64-binutils mingw-w64-x86_64-make mingw-w64-x86_64-cmake mingw-w64-x86_64-pkgconf mingw-w64-x86_64-SDL2 mingw-w64-x86_64-SDL2_ttf
+```
+
+clone the git repository (to get the code):
+```
+git clone https://github.com/sharkwouter/laserkombat.git
+```
+
+To build execute the following commands from a terminal in the directory where the code is found:
+
+```
+mkdir build
+cd build
+cmake -G "MinGW Makefiles" ..
+cmake --build .
+```
+
+Then the game can be started through ``laserkombat.exe`. It should be in ``C:\msys2\mingw64\home\YOUR-USERNAME\laserkombat\build``.
+
+## Other platforms
+
+It is possible to build for Vita and Xbox with their respective homebrew SDKs. These ports are not finished or supported at the moment, though. Please submit an issue if you'd like to work on them.