From d566499c3c6bcb8945bc9f0253508cc273582880 Mon Sep 17 00:00:00 2001
From: Jeroen Wijenbergh <jeroenwijenbergh@protonmail.com>
Date: Mon, 25 Apr 2022 16:43:36 +0200
Subject: Docs: Update with more sections

---
 docs/src/gettingstarted/building.md | 65 +++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 docs/src/gettingstarted/building.md

(limited to 'docs/src/gettingstarted/building.md')

diff --git a/docs/src/gettingstarted/building.md b/docs/src/gettingstarted/building.md
new file mode 100644
index 0000000..8747cd7
--- /dev/null
+++ b/docs/src/gettingstarted/building.md
@@ -0,0 +1,65 @@
+# Building
+To build the Go library, you need the dependencies for your system installed. We will go over the needed dependencies for Linux and Windows. Afterwards, we explain the basic commands to build the library.
+## Linux
+To build the GO shared library using Linux you need the following dependencies:
+
+- [Go](https://go.dev/doc/install) 1.15 or later
+- [Gcc](https://gcc.gnu.org/)
+- [GNU Make](https://www.gnu.org/software/make/)
+- Dependencies for each wrapper you are interested in
+
+## Windows
+On Windows, you can install gcc and make (or even Go) via MinGW or Cygwin or use WSL. For MinGW:
+
+1. [Install MinGW](https://www.msys2.org/#installation) (you don't need to install any extra packages yet) and open some
+   MSYS2 terminal (e.g. from the start menu or one of the installed binaries)
+2. Install the [`make`](https://packages.msys2.org/package/make?repo=msys) package (`pacman -S make`) (or
+   e.g. [`mingw-w64-x86_64-make`](https://packages.msys2.org/package/mingw-w64-x86_64-make?repo=mingw64) and
+   use `mingw32-make` in the command line)
+3. To compile for x86_64:
+    1. Install the [`mingw-w64-x86_64-gcc`](https://packages.msys2.org/package/mingw-w64-x86_64-gcc?repo=mingw64)
+       package
+    2. Open the MinGW 64-bit console, via the start menu, or in your current
+       terminal: `path/to/msys64/msys2_shell.cmd -mingw64 -defterm -no-start -use-full-path`
+    3. Run the make commands in the project directory
+4. To compile for x86 (32-bit):
+    1. Install the [`mingw-w64-i686-gcc`](https://packages.msys2.org/package/mingw-w64-i686-gcc?repo=mingw32) package
+    2. Open the MinGW 32-bit console, via the start menu, or in your current
+       terminal: `path/to/msys64/msys2_shell.cmd -mingw32 -defterm -no-start -use-full-path`
+    3. Run the make commands in the project directory
+
+## Commands
+To build the shared library for the current platform issue the following command in the root directory:
+
+```bash
+make
+```
+
+Build shared library for specified OS & architecture (example):
+
+```bash
+make GOOS=windows GOARCH=386
+```
+
+To list all platforms supported by cgo, run `go tool dist list`.
+
+Results will be output in `exports/lib/`.
+
+Usually you will need to specify the compiler when cross compiling, for example:
+
+```bash
+make GOOS=windows GOARCH=amd64 CC=x86_64-w64-mingw32-gcc
+```
+
+For example, you can cross compile for Windows from Linux using [MinGW-w64](https://www.mingw-w64.org/downloads/).
+
+### Cleaning
+Clean built libraries and wrapper builds:
+
+```bash
+make -j clean
+```
+
+Usually you won't need to do this, as changes in the library should automatically be incorporated in wrappers.
+Specify `CLEAN_ALL=1` to also remove downloaded dependencies for some wrappers. You can clean individual wrappers by
+executing clean in their directories, or specify `WRAPPERS=...`.
-- 
cgit v1.2.3