README: Add Documentation blurb
PATCH 1/1 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.
--- README.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)
README.rst +11 -0
@@ -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 ========
Signature · 1 line
2.26.2
Quoted 14 lines · John Snow
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 <[email protected]>--- README.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)README.rst +0
-0
README.rst QEMU as a whole is released under the GNU General Public License, · line 40
Quoted 10 lines
README.rst +7
-0@@ -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/``
That URL is now redirecting to https://qemu.readthedocs.io/en/latest/ ... could you maybe update your patch and resend?
Thanks,
Thomas
Quoted 27 lines · Thomas Huth
Quoted 16 lines · John Snow
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 <[email protected]>---
README.rst| 11 +++++++++++1 file changed, 11 insertions(+)README.rst +0
-0@@ -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.
README.rst QEMU as a whole is released under the GNU General Public License, · line 40
Quoted 7 lines
README.rst +7
-0+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/``That URL is now redirecting to https://qemu.readthedocs.io/en/latest/ ... could you maybe update your patch and resend?
Quoted 2 lines
Thanks,
Thomas
does "v: latest" on readthedocs mean 5.2.0 or the current development head? Looks like the current development head.
https://www.qemu.org/documentation/ points to /docs/master, which is why I took that link. Is it worth updating that link, too? The website in particular should be rephrased to point to the latest stable release docs as a default, I suspect.
The README should probably keep pointing to the latest development docs.
--js