From 688175f8bb6a4ae2c6589b5faabf08e3dd15e2f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Remko=20Tron=C3=A7on?= Date: Mon, 24 May 2010 20:32:23 +0200 Subject: Added some building documentation. 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. -- cgit v0.10.2-6-g49f6