summaryrefslogtreecommitdiffstats
path: root/packaging/windows/README.md
diff options
context:
space:
mode:
authorGravatar Dirk Hohndel <dirk@hohndel.org>2020-09-28 10:33:25 -0700
committerGravatar Dirk Hohndel <dirk@hohndel.org>2020-09-28 10:38:08 -0700
commit63cc2d864fe8e5c776f3675067100a907a45b2f3 (patch)
tree06909a30521c7c8c83091f2a7206367d54d31bf4 /packaging/windows/README.md
parent6835f03bae324d45fb5f6970beb26b781bfb8c24 (diff)
downloadsubsurface-63cc2d864fe8e5c776f3675067100a907a45b2f3.tar.gz
build-system: document how to create a Windows installer
These are the instructions that I use at this point. Removed a long obsolete script - it's been many, many years since that last was useful (it was still using qmake to try to build Subsurface) Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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.