]> xenbits.xensource.com Git - qemu-xen.git/commitdiff
README: Add Documentation blurb
authorJohn Snow <jsnow@redhat.com>
Wed, 4 Nov 2020 19:30:32 +0000 (14:30 -0500)
committerThomas Huth <thuth@redhat.com>
Fri, 12 Mar 2021 14:46:30 +0000 (15:46 +0100)
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>
README.rst

index 91aa1e314c56a428df43fd5f01c864949edc0146..a92c7394b7ff3ef29bddf83f4c4248ae6dc08709 100644 (file)
@@ -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
 ========