From: Thomas Huth <thuth@redhat.com>
To: qemu-devel@nongnu.org, Peter Maydell <peter.maydell@linaro.org>
Cc: "Alex Bennée" <alex.bennee@linaro.org>
Subject: [PULL 9/9] README: Add Documentation blurb
Date: Fri, 12 Mar 2021 18:23:56 +0100 [thread overview]
Message-ID: <20210312172356.968219-10-thuth@redhat.com> (raw)
In-Reply-To: <20210312172356.968219-1-thuth@redhat.com>
From: John Snow <jsnow@redhat.com>
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 | 11 +++++++++++
1 file changed, 11 insertions(+)
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
========
--
2.27.0
next prev parent reply other threads:[~2021-03-12 18:18 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-12 17:23 [PULL 0/9] Gitlab-CI, tests and docs Thomas Huth
2021-03-12 17:23 ` [PULL 1/9] tests: Move unit tests into a separate directory Thomas Huth
2021-03-12 17:23 ` [PULL 2/9] tests: Move benchmarks into a separate folder Thomas Huth
2021-03-12 17:23 ` [PULL 3/9] gitlab-ci.yml: Move build-tools-and-docs-debian to a better place Thomas Huth
2021-03-12 17:23 ` [PULL 4/9] gitlab-ci.yml: Add some missing dependencies to the jobs Thomas Huth
2021-03-12 17:23 ` [PULL 5/9] gitlab-ci.yml: Merge one of the coroutine jobs with the tcg-disabled job Thomas Huth
2021-03-12 17:23 ` [PULL 6/9] gitlab-ci.yml: Merge check-crypto-old jobs into the build-crypto-old jobs Thomas Huth
2021-03-12 17:23 ` [PULL 7/9] tests: remove "make check-speed" in favor of "make bench" Thomas Huth
2021-03-12 17:23 ` [PULL 8/9] MAINTAINERS: Merge the Gitlab-CI section into the generic CI section Thomas Huth
2021-03-12 17:23 ` Thomas Huth [this message]
2021-03-14 17:47 ` [PULL 0/9] Gitlab-CI, tests and docs Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210312172356.968219-10-thuth@redhat.com \
--to=thuth@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).