aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2020-11-04 14:30:32 -0500
committerThomas Huth <thuth@redhat.com>2021-03-12 15:46:30 +0100
commit33bf47291ed575847d7de26b503c50e72f5aa6c3 (patch)
treee2edb33fd960864dfb513be5f8d8b0c9ae66789e /README.rst
parent9872ba0a8ab01a9af9f62e780c22edf86e0bc804 (diff)
README: Add Documentation blurb
Add it in a prominent place: Right after figuring out what QEMU is, users may wish to know how to use it more than they want to know how to build their own version of it. Signed-off-by: John Snow <jsnow@redhat.com> Message-Id: <20201104193032.1319248-1-jsnow@redhat.com> Signed-off-by: Thomas Huth <thuth@redhat.com>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 91aa1e314c..a92c7394b7 100644
--- a/README.rst
+++ b/README.rst
@@ -31,6 +31,17 @@ QEMU as a whole is released under the GNU General Public License,
version 2. For full licensing details, consult the LICENSE file.
+Documentation
+=============
+
+Documentation can be found hosted online at
+`<https://www.qemu.org/documentation/>`_. The documentation for the
+current development version that is available at
+`<https://www.qemu.org/docs/master/>`_ is generated from the ``docs/``
+folder in the source tree, and is built by `Sphinx
+<https://www.sphinx-doc.org/en/master/>_`.
+
+
Building
========