mirrors/qemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move README to markdown

Browse Source 
Move the README file to markdown so that it makes the github page look
prettier. I know that github repo is a mirror and not the official
repo, but I think it doesn't hurt to have it in markdown format.

Signed-off-by: Pranith Kumar <bobby.prani@gmail.com>
Message-Id: <20160715043111.29007-1-bobby.prani@gmail.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
This commit is contained in:
Pranith Kumar 2016-07-15 00:31:11 -04:00 committed by Paolo Bonzini
parent ca7d8e1c9c
commit e5dfc5e8e7
1 changed files with 20 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README → README.md
View File

@ -1,5 +1,5 @@
QEMU README QEMU
=========== ---
QEMU is a generic and open source machine & userspace emulator and QEMU is a generic and open source machine & userspace emulator and
virtualizer. virtualizer.
@ -31,31 +31,31 @@ version 2. For full licensing details, consult the LICENSE file.
Building Building
======== ---
QEMU is multi-platform software intended to be buildable on all modern QEMU is multi-platform software intended to be buildable on all modern
Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
of other UNIX targets. The simple steps to build QEMU are: of other UNIX targets. The simple steps to build QEMU are:
mkdir build mkdir build
cd build cd build
../configure ../configure
make make
Complete details of the process for building and configuring QEMU for Complete details of the process for building and configuring QEMU for
all supported host platforms can be found in the qemu-tech.html file. all supported host platforms can be found in the qemu-tech.html file.
Additional information can also be found online via the QEMU website: Additional information can also be found online via the QEMU website:
http://qemu-project.org/Hosts/Linux http://qemu-project.org/Hosts/Linux
http://qemu-project.org/Hosts/W32 http://qemu-project.org/Hosts/W32
Submitting patches Submitting patches
================== ---
The QEMU source code is maintained under the GIT version control system. The QEMU source code is maintained under the GIT version control system.
git clone git://git.qemu-project.org/qemu.git git clone git://git.qemu-project.org/qemu.git
When submitting patches, the preferred approach is to use 'git When submitting patches, the preferred approach is to use 'git
format-patch' and/or 'git send-email' to format & send the mail to the format-patch' and/or 'git send-email' to format & send the mail to the
@ -66,18 +66,18 @@ guidelines set out in the HACKING and CODING_STYLE files.
Additional information on submitting patches can be found online via Additional information on submitting patches can be found online via
the QEMU website the QEMU website
http://qemu-project.org/Contribute/SubmitAPatch http://qemu-project.org/Contribute/SubmitAPatch
http://qemu-project.org/Contribute/TrivialPatches http://qemu-project.org/Contribute/TrivialPatches
Bug reporting Bug reporting
============= ---
The QEMU project uses Launchpad as its primary upstream bug tracker. Bugs The QEMU project uses Launchpad as its primary upstream bug tracker. Bugs
found when running code built from QEMU git or upstream released sources found when running code built from QEMU git or upstream released sources
should be reported via: 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 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 is preferable to report bugs to the vendor's own bug tracker first. If
@ -86,22 +86,21 @@ reported via launchpad.
For additional information on bug reporting consult: For additional information on bug reporting consult:
http://qemu-project.org/Contribute/ReportABug http://qemu-project.org/Contribute/ReportABug
Contact Contact
======= ---
The QEMU community can be contacted in a number of ways, with the two The QEMU community can be contacted in a number of ways, with the two
main methods being email and IRC main methods being email and IRC
- qemu-devel@nongnu.org - Mailing List: qemu-devel@nongnu.org
http://lists.nongnu.org/mailman/listinfo/qemu-devel - Archives: http://lists.nongnu.org/mailman/listinfo/qemu-devel
- #qemu on irc.oftc.net - IRC: #qemu on irc.oftc.net
Information on additional methods of contacting the community can be Information on additional methods of contacting the community can be
found online via the QEMU website: found online via the QEMU website:
http://qemu-project.org/Contribute/StartHere http://qemu-project.org/Contribute/StartHere
-- End