diff options
| -rw-r--r-- | Documentation/BuildingOnUnix.txt | 25 | ||||
| -rw-r--r-- | Documentation/BuildingOnWindows.txt | 10 | 
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. | 
 Swift
 Swift