aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README8
-rw-r--r--README.md31
-rw-r--r--doc/doc.qbs2
3 files changed, 32 insertions, 9 deletions
diff --git a/README b/README
deleted file mode 100644
index 5c11c8465..000000000
--- a/README
+++ /dev/null
@@ -1,8 +0,0 @@
-Qbs
-===
-Qbs is a cross-platform build tool.
-The project's homepage is http://wiki.qt.io/qbs
-Qbs product documentation is available at: http://doc.qt.io/qbs/index.html
-
-For more information about building Qbs from sources, see
-"Appendix A: Building Qbs" at: http://doc.qt.io/qbs/building-qbs.html.
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..6f4a1bf9e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Qbs
+
+Qbs is a build automation tool designed to conveniently manage the build
+process of software projects across multiple platforms. Qbs can be used for any
+software project, regardless of programming language, toolkit, or libraries used.
+
+## Documentation
+
+Qbs product documentation is available at [doc.qt.io/qbs](http://doc.qt.io/qbs/index.html)
+
+The project's homepage is [wiki.qt.io/qbs](http://wiki.qt.io/qbs)
+
+## Supported platforms
+
+Qbs binaries are available for Windows, macOS, Linux, and FreeBSD.
+
+For more information about how to install Qbs on your platform, see the
+[Installing](https://doc.qt.io/qbs/installing.html) page in the documentation.
+
+Qbs allows to build applications for different platforms, for the list of
+supported platforms and the details about each platform, see the
+[Target Platforms](https://doc.qt.io/qbs/platforms.html) page.
+
+## Building Qbs
+
+For information about building Qbs from sources, see
+["Appendix A: Building Qbs"](http://doc.qt.io/qbs/building-qbs.html).
+
+## Reporting Bugs
+
+Please report any bugs in our [bug tracker](https://bugreports.qt.io/browse/QBS).
diff --git a/doc/doc.qbs b/doc/doc.qbs
index dd8377c6c..06e02bd72 100644
--- a/doc/doc.qbs
+++ b/doc/doc.qbs
@@ -17,7 +17,7 @@ Project {
Depends { name: "qbsversion" }
files: [
- "../README",
+ "../README.md",
"classic.css",
"external-resources.qdoc",
"fixnavi.pl",