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/BuildingOnUnix.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/BuildingOnUnix.txt')
-rw-r--r--Documentation/BuildingOnUnix.txt35
1 files changed, 0 insertions, 35 deletions
diff --git a/Documentation/BuildingOnUnix.txt b/Documentation/BuildingOnUnix.txt
deleted file mode 100644
index b9f31ea..0000000
--- a/Documentation/BuildingOnUnix.txt
+++ /dev/null
@@ -1,35 +0,0 @@
-Prerequisites
-------------
-- GCC
-- Python
-- OpenSSL (and development package)
-- Qt Open Source Edition (and development package. Optional; not needed for Swiften)
-
-Building
---------
-- Swift uses Qt5 for the UI and on Unix-like platforms it is automatically detected
- using pkg-config.
- - The dependencies can be installed by running ./BuildTools/InstallSwiftDependencies.sh
-- Run
- ./scons
-- To build only a subdir, add the path as a target to scons. E.g., for Swift:
- ./scons Swift
-
-Running tests
--------------
-If you want to run the unit tests (only interesting if you're doing development work)
-- Run
- ./scons test=unit
- for running the unit tests.
-
-Installing
-----------
-- To install swift in /usr/local, run
- ./scons SWIFT_INSTALLDIR=/usr/local /usr/local
-
-Swiften-only
-------------
-- To compile just Swiften, add Swiften to the end of the scons command
- ./scons Swiften
-- To compile and install only Swiften, use SWIFTEN_INSTALLDIR
- ./scons SWIFTEN_INSTALLDIR=/usr/local /usr/local