summaryrefslogtreecommitdiffstats
path: root/packaging/windows/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packaging/windows/README.md')
-rw-r--r--packaging/windows/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/packaging/windows/README.md b/packaging/windows/README.md
new file mode 100644
index 000000000..803df2c50
--- /dev/null
+++ b/packaging/windows/README.md
@@ -0,0 +1,18 @@
+# Creating a Windows installer
+
+The scripts here help with cross building Subsurface and smtk2ssrf for Windows.
+
+The preferred method to create a Windows installer is to use our own docker
+image that has all the build components pre-assembled.
+All it takes is this:
+
+```
+cd /some/path/windows
+git clone git://github.com/subsurface/subsurface
+cd subsurface
+git submodule init
+git submodule update
+docker run -v /some/path/windows:/__w subsurface/mxe-build-container:1.1 /bin/bash /__w/subsurface/packaging/windows/create-win-installer.sh
+```
+
+This will result in subsurface-VERSION.exe and smtk2ssrf-VERSION.exe to be created.