similarity index 67%
rename from README
rename to README.md
@@ -1,5 +1,4 @@
- QEMU README
- ===========
+# Qemu
QEMU is a generic and open source machine & userspace emulator and
virtualizer.
@@ -27,89 +26,93 @@ It is commonly invoked indirectly via the libvirt library when using
open source applications such as oVirt, OpenStack and virt-manager.
QEMU as a whole is released under the GNU General Public License,
-version 2. For full licensing details, consult the LICENSE file.
+version 2. For full licensing details, consult the [LICENSE](LICENSE) file.
-Building
-========
+## Building
QEMU is multi-platform software intended to be buildable on all modern
Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
of other UNIX targets. The simple steps to build QEMU are:
- mkdir build
- cd build
- ../configure
- make
+```
+mkdir build
+cd build
+../configure
+make
+```
Additional information can also be found online via the QEMU website:
- https://qemu.org/Hosts/Linux
- https://qemu.org/Hosts/Mac
- https://qemu.org/Hosts/W32
+* https://qemu.org/Hosts/Linux
+* https://qemu.org/Hosts/Mac
+* https://qemu.org/Hosts/W32
-Submitting patches
-==================
+## Submitting patches
The QEMU source code is maintained under the GIT version control system.
- git clone git://git.qemu.org/qemu.git
+`git clone git://git.qemu.org/qemu.git`
-When submitting patches, one common approach is to use 'git
-format-patch' and/or 'git send-email' to format & send the mail to the
-qemu-devel@nongnu.org mailing list. All patches submitted must contain
-a 'Signed-off-by' line from the author. Patches should follow the
-guidelines set out in the HACKING and CODING_STYLE files.
+When submitting patches, one common approach is to use `git format-patch`
+and/or `git send-email` to format & send the mail to the
+[qemu-devel@nongnu.org](https://lists.nongnu.org/mailman/listinfo/qemu-devel)
+mailing list. All patches submitted must contain a 'Signed-off-by' line from
+the author. Patches should follow the guidelines set out in the
+[HACKING.md](HACKING.md) and [CODING_STYLE.md](CODING_STYLE.md) files.
Additional information on submitting patches can be found online via
the QEMU website
- https://qemu.org/Contribute/SubmitAPatch
- https://qemu.org/Contribute/TrivialPatches
+* https://qemu.org/Contribute/SubmitAPatch
+* https://qemu.org/Contribute/TrivialPatches
The QEMU website is also maintained under source control.
- git clone git://git.qemu.org/qemu-web.git
- https://www.qemu.org/2017/02/04/the-new-qemu-website-is-up/
+`git clone git://git.qemu.org/qemu-web.git`
+* https://www.qemu.org/2017/02/04/the-new-qemu-website-is-up/
-A 'git-publish' utility was created to make above process less
+A `git-publish` utility was created to make above process less
cumbersome, and is highly recommended for making regular contributions,
or even just for sending consecutive patch series revisions. It also
-requires a working 'git send-email' setup, and by default doesn't
+requires a working `git send-email` setup, and by default doesn't
automate everything, so you may want to go through the above steps
manually for once.
For installation instructions, please go to
- https://github.com/stefanha/git-publish
+* https://github.com/stefanha/git-publish
The workflow with 'git-publish' is:
- $ git checkout master -b my-feature
- $ # work on new commits, add your 'Signed-off-by' lines to each
- $ git publish
+```
+git checkout master -b my-feature
+# work on new commits, add your 'Signed-off-by' lines to each
+git publish
+```
Your patch series will be sent and tagged as my-feature-v1 if you need to refer
back to it in the future.
Sending v2:
- $ git checkout my-feature # same topic branch
- $ # making changes to the commits (using 'git rebase', for example)
- $ git publish
+```
+git checkout my-feature # same topic branch
+# making changes to the commits (using 'git rebase', for example)
+git publish
+```
Your patch series will be sent with 'v2' tag in the subject and the git tip
will be tagged as my-feature-v2.
-Bug reporting
-=============
+## Bug reporting
The QEMU project uses Launchpad as its primary upstream bug tracker. Bugs
found when running code built from QEMU git or upstream released sources
should be reported via:
- https://bugs.launchpad.net/qemu/
+* https://bugs.launchpad.net/qemu/
If using QEMU via an operating system vendor pre-built binary package, it
is preferable to report bugs to the vendor's own bug tracker first. If
@@ -118,22 +121,20 @@ reported via launchpad.
For additional information on bug reporting consult:
- https://qemu.org/Contribute/ReportABug
+* https://qemu.org/Contribute/ReportABug
-Contact
-=======
+## Contact
The QEMU community can be contacted in a number of ways, with the two
main methods being email and IRC
- - qemu-devel@nongnu.org
- https://lists.nongnu.org/mailman/listinfo/qemu-devel
- - #qemu on irc.oftc.net
+* [qemu-devel@nongnu.org](https://lists.nongnu.org/mailman/listinfo/qemu-devel)
+* #qemu on irc.oftc.net
Information on additional methods of contacting the community can be
found online via the QEMU website:
- https://qemu.org/Contribute/StartHere
+* https://qemu.org/Contribute/StartHere
+## End
@@ -407,7 +407,7 @@ sub top_of_kernel_tree {
my @tree_check = (
"COPYING", "MAINTAINERS", "Makefile",
- "README", "docs", "VERSION",
+ "README.md", "docs", "VERSION",
"vl.c"
);
Also updated scripts/checkpatch.pl and made it reference to README.md instead of README. Signed-off-by: Yoni Bettan <ybettan@redhat.com> --- README => README.md | 89 ++++++++++++++++++++++--------------------- scripts/checkpatch.pl | 2 +- 2 files changed, 46 insertions(+), 45 deletions(-) rename README => README.md (67%)