From b3f25c7e651de922670c774e1b87f7e3fd2c353e Mon Sep 17 00:00:00 2001
From: Peter Repukat <orly.alia5@gmail.com>
Date: Sun, 31 Oct 2021 11:53:27 +0100
Subject: [PATCH] Add building / contributing files

---
 BUILDING.md     | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 CONTRIBUTING.md | 19 +++++++++++++++++++
 2 files changed, 68 insertions(+)
 create mode 100644 BUILDING.md
 create mode 100644 CONTRIBUTING.md

diff --git a/BUILDING.md b/BUILDING.md
new file mode 100644
index 0000000..897e4f7
--- /dev/null
+++ b/BUILDING.md
@@ -0,0 +1,49 @@
+# Building GlosSI
+
+## Windows
+
+Requirements:
+
+- Visual Studio 2019 (Community edition is fine)
+- Qt 6.2.0 (GlosSIConfig only)
+- Qt Visual Studio addin (GlosSIConfig only)
+
+```bat
+git submodule init
+git submodule update --recursive
+buildSFML.bat
+buildViGEmClient.bat
+
+:: Open GlosSI.sln and hit build!
+start GlosSI.sln
+```
+
+In addition to the above, you will need to install the required drivers:  
+`ViGEmBusSetup_x64.msi` and `HidHideMSI.msi`  
+Both of which can be downloed from [ViGEm's website](https://vigem.org/Downloads/) or by use of the `download_release_deps.ps1` script.
+
+## Linux
+
+Linux support is currently not really implemented.  
+That said, very limited linux support is planned for the future.  
+No Guarantees that the build works out!
+
+Building should be as easy as:
+
+**GlosSITarget:**
+
+```shell
+git submodule init
+git submodule update --recursive
+
+# build custom fork of SFML
+# do not use SFML you might've already installed
+./buildSFML.sh 
+cd GlosSITarget
+cmake -S . -B build
+cmake --build build
+```
+
+**GlosSIConfig:**
+
+TODO
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..f5611b6
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+# Contributing
+
+Feel free to take on any feature-request, bug report or whatever idea you have.  
+If you feel like it, you can also look at the many TODOs sprinkled throughout the code.
+
+## Building / Dev environment
+
+For building instructions see [BUILDING.md](./BUILDING.md)
+
+If you need technical assistance, reach out via e-mail or any other channel you might find.  
+Please get to the chase right away, though, as I get way to much spam.  
+Please also note, that I'm short on time and might not reply immediately  
+Also I'm least available on Discord.
+
+## Pull Requests
+
+Please keep your feature branch up to date with the latest changes from the `develop` branch.  
+
+Use [git-rebase](https://git-scm.com/docs/git-rebase); If your feature branch contains backmerges it will be ignored.
\ No newline at end of file