summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTobias Markmann <tm@ayena.de>2016-04-27 10:54:18 (GMT)
committerKevin Smith <kevin.smith@isode.com>2016-04-29 07:47:38 (GMT)
commit195300fc8b42f5c54eee2359f497b9dc28c6d27d (patch)
tree9e0d47ba54cb59c89a4874385a926e2b1aca2894 /Documentation/BuildingOnWindows.txt
parent0709bd664af7a052f2fb7dae2b04e37afed8fdde (diff)
downloadswift-195300fc8b42f5c54eee2359f497b9dc28c6d27d.zip
swift-195300fc8b42f5c54eee2359f497b9dc28c6d27d.tar.bz2
Restructure and reword project documentation
Restructured project documentation into two basically two files at the top level. README.md giving a rough project overview and information and providing all information needed to build Swift, its requirements and where to get them for all desktop platforms. DEVELOPMENT.md is targeted at developers, describing the build system, how to build only parts of the project. This document also described how to build Swiften on Android and iOS, and also covers testing and packaging guidelines. Test-Information: None. Change-Id: Ic47bef6524888db972332b23e6510d10234f7808
Diffstat (limited to 'Documentation/BuildingOnWindows.txt')
-rw-r--r--Documentation/BuildingOnWindows.txt66
1 files changed, 0 insertions, 66 deletions
diff --git a/Documentation/BuildingOnWindows.txt b/Documentation/BuildingOnWindows.txt
deleted file mode 100644
index d296241..0000000
--- a/Documentation/BuildingOnWindows.txt
+++ /dev/null
@@ -1,66 +0,0 @@
-Prerequisites
-------------
-- Microsoft Visual C++ Express Edition
-- Windows SDK
-- Python (2.5 <= version < 3)
-- OpenSSL
- * OpenSSL is optional - without it the Windows platform crypto will be used
- * Download and extract the Windows binary version of OpenSSL from
- http://www.slproweb.com/products/Win32OpenSSL.html
-- Qt Open Source Edition (optional; not needed for Swiften)
-
-Building Qt for Microsoft Visual C++
-------------------------------------
-- These steps are optional - the pre-packaged Qt is fine
-- From the 'Visual C++' 'Programs' group, launch the Visual C++ command prompt
-- Go to the dir where you installed Qt
-- Configure Qt:
- configure
-- Build Qt:
- nmake
-
-Building Swift
---------------
-- From the 'Visual C++' 'Programs' group, launch the Visual C++ command prompt
-- Go to the Swift source dir
-- Create a file 'config.py' with the following contents, reflecting your local
- setup:
- openssl = "path\to\openssl" #optional
- qt = "path\to\qt"
-- Run 'scons'
-- To build only a subdir, add the path as a target to scons. E.g., for Swift:
- scons Swift
-
-Running tests
--------------
-- Run
- scons test=unit
- for running the unit tests, or
- scons test=all
- for running all tests.
-
-Packaging Swift
----------------
-For packaging use:
-- Microsoft Visual C++ Express 2008 or Microsoft VS 2013 Express
-- No OpenSSL
-- WiX
-- Download the C++ redistributable package from Microsoft and put it at C:\Program Files (x86)\Common Files\Merge Modules\
-- config.py should contain:
- qt = "c:\\qt\\5.4.2"
- vcredist = "C:\\Program Files (x86)\\Common Files\\Merge Modules\\vcredist_x86.exe"
- debug = 1
- optimize = 1
- wix_bindir = "c:\\program files\\Windows Installer XML v3.5\\bin"
-- run the following commands. Two scons runs are required as 'scons dist=1' requires the Swift.exe to be in place.
- scons
- scons dist=1
-
-Notes
------
-- The settings debug = 1 and optimize = 1 are strictly required if you use
- a precompiled Qt release from the Qt Project; otherwise you will get linker
- errors
-- On 64-bit Windows it's "Program Files (x86)" instead of "Program Files" in the
- paths
-- Currently only 32-bit builds of the Swift client are supported