aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorJoerg Bornemann <joerg.bornemann@digia.com>2013-06-27 08:24:37 +0200
committerChristian Kandeler <christian.kandeler@digia.com>2013-06-27 10:30:20 +0200
commit0cb8c8b1092671dba8245a2e01a332429aabeed4 (patch)
tree6040843ef4fedd2e33445ed333e8db1bd4128ec7 /README
parentd9d2d5c8b6bf43b8e67fb67c55dd0ac7766693f9 (diff)
adjust README
Shamelessly stolen from Qt Creator. Change-Id: I896208e39cafb337d5b35ea95674fd1c362d83b4 Reviewed-by: Christian Kandeler <christian.kandeler@digia.com>
Diffstat (limited to 'README')
-rw-r--r--README38
1 files changed, 26 insertions, 12 deletions
diff --git a/README b/README
index 54656196d..21f058c21 100644
--- a/README
+++ b/README
@@ -1,20 +1,34 @@
-This is qbs; the "Qt Build Salvation".
-The main documentation is available as qdoc files in the doc subdirectory.
+Qt Build Suite
+==============
+Qbs is a cross-platform build tool.
+The project's homepage is http://qt-project.org/wiki/qbs
+Supported Platforms
+===================
-1. Build Prerequisites
-======================
+Windows XP SP2 or later
+Mac OS 10.6 or later
+Linux (tested on Debian 6/7 and Ubuntu 13)
-For building qbs you need:
+Building the sources requires Qt 4.8.0 or later.
- - a C++ compiler
- - Qt >= 4.8
+Build Instructions
+==================
+Prerequisites:
+ * Qt 4.8.0 or later
+ * On Windows:
+ - MinGW or Visual Studio
+ * On Mac: Xcode
+The installed toolchains have to match the one Qt was compiled with.
-2. Building qbs
-===============
+You can build qbs with
- - qmake -r qbs.pro
- - make
- - make docs
+ cd $SOURCE_DIRECTORY
+ qmake -r
+ make (or mingw32-make or nmake or jom, depending on your platform)
+
+Installation ("make install") is not needed. It is however possible, using
+
+ make install INSTALL_ROOT=$INSTALL_DIRECTORY