aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..c56d8c214
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# 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).
+
+## Contributing
+
+See [Contributing to Qbs](CONTRIBUTING.md)
+