summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRemko Tronçon <git@el-tramo.be>2010-05-24 18:32:23 (GMT)
committerRemko Tronçon <git@el-tramo.be>2010-05-24 18:32:23 (GMT)
commit688175f8bb6a4ae2c6589b5faabf08e3dd15e2f1 (patch)
tree3d9fd8f2e8ea0c247e9f55b43e239d55146fac21
parente7c2c49013c50c513fd062036cc15f1fb1b69aa5 (diff)
downloadswift-688175f8bb6a4ae2c6589b5faabf08e3dd15e2f1.zip
swift-688175f8bb6a4ae2c6589b5faabf08e3dd15e2f1.tar.bz2
Added some building documentation.
-rw-r--r--Documentation/BuildingOnUnix.txt25
-rw-r--r--Documentation/BuildingOnWindows.txt10
2 files changed, 35 insertions, 0 deletions
diff --git a/Documentation/BuildingOnUnix.txt b/Documentation/BuildingOnUnix.txt
new file mode 100644
index 0000000..8de73c8
--- /dev/null
+++ b/Documentation/BuildingOnUnix.txt
@@ -0,0 +1,25 @@
+Prerequisites
+------------
+- GCC
+- Python
+- OpenSSL
+- Qt Open Source Edition (optional; not needed for Swiften)
+
+Building
+--------
+- Create a file 'config.py' with the following contents, reflecting your local
+ setup:
+ qt = "path/to/qt"
+ (e.g. qt = "/usr/share/qt4")
+- 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.
diff --git a/Documentation/BuildingOnWindows.txt b/Documentation/BuildingOnWindows.txt
index 6f599be..fe2080c 100644
--- a/Documentation/BuildingOnWindows.txt
+++ b/Documentation/BuildingOnWindows.txt
@@ -25,3 +25,13 @@ Building Swift
openssl = "path\to\openssl"
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.