From 89c39056021da49fd222b5f06b4915c486555524 Mon Sep 17 00:00:00 2001
From: Wouter Wijsman <wwijsman@live.nl>
Date: Thu, 28 Dec 2023 18:59:08 +0100
Subject: [PATCH] Add basic build instructions (#138)

---
 docs/building.md | 34 ++++++++++++++++++++++++++++++++++
 docs/index.md    |  4 +++-
 2 files changed, 37 insertions(+), 1 deletion(-)
 create mode 100644 docs/building.md

diff --git a/docs/building.md b/docs/building.md
new file mode 100644
index 00000000..165bfc8e
--- /dev/null
+++ b/docs/building.md
@@ -0,0 +1,34 @@
+# How to build
+
+To be able to make changes to the Open1560 code a development environment is required. This page will explain how to set this up.
+
+## Visual Studio 2022
+
+The Open1560 code is build and developed using Visual Studio 2022. The community edition can be downloaded [here](https://visualstudio.microsoft.com/vs/community/). Make sure to select `Desktop Development with C++" during the installation.
+
+## Git clone
+
+Use [git](https://git-scm.com/) bash to clone the repo with the following command:
+```
+git clone https://github.com/0x1F9F1/Open1560.git
+```
+
+Replace `0x1F9F1` with your own GitHub username if you created a fork already.
+
+This will create the Open1560 directory.
+
+## Prepare script
+
+After having done that, shift+right click on the directory Open1560 directory and select "Open PowerShell window here". Then run the following command with after replacing the location of the Midtown Madness in it:
+
+```
+tools/premake5.exe --MM1_GAME_DIRECTORY=c:/location/of/mm1/installation
+```
+
+Make sure to use `/`s and not `\`s in the Midtown Madness path.
+
+This will create the Visual Studio project files which will be used in the next step.
+
+## Get started
+
+Now the code can be openened by double clicking the newly created `build/Open1560.sln` project file for Visual Studio. If all the previous steps were done correctly, clicking `Start Debugging` at the top of the screen in Visual Studio should build and run Open1560. Feel free to play around with the code and make changes.
diff --git a/docs/index.md b/docs/index.md
index 668b1703..da4238bf 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -16,7 +16,9 @@ title: Open1560
 * Do I need to install dgVoodoo2?
     * No, Open1560 uses an OpenGL renderer.
 * What does Open1560 change?
-    * See a list of changes [here](./changes.md)
+    * See a list of changes [here](./changes.md).
+* How do I work with the Open1560 code?
+    * See the build instructions [here](./building.md).
 
 # Support