[PATCH] README: Add Documentation blurb

[PATCH] README: Add Documentation blurb

[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 <jsnow@redhat.com>
---
 README.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.rst b/README.rst
index 58b9f2dc15c4..758ea8fd2ff0 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
 ========
 
-- 
2.26.2

Re: [PATCH] README: Add Documentation blurb

[Thomas Huth]

On 04/11/2020 20.30, John Snow wrote:
> 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>
> ---
>   README.rst | 11 +++++++++++
>   1 file changed, 11 insertions(+)
> 
> diff --git a/README.rst b/README.rst
> index 58b9f2dc15c4..758ea8fd2ff0 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/``

That URL is now redirecting to https://qemu.readthedocs.io/en/latest/ ... 
could you maybe update your patch and resend?

  Thanks,
   Thomas

Re: [PATCH] README: Add Documentation blurb

[John Snow]

On 2/4/21 9:07 AM, Thomas Huth wrote:
> On 04/11/2020 20.30, John Snow wrote:
>> 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>
>> ---
>>   README.rst | 11 +++++++++++
>>   1 file changed, 11 insertions(+)
>>
>> diff --git a/README.rst b/README.rst
>> index 58b9f2dc15c4..758ea8fd2ff0 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/``
> 
> That URL is now redirecting to https://qemu.readthedocs.io/en/latest/ 
> ... could you maybe update your patch and resend?
> 
>   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