-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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 <[email protected]> Message-Id: <[email protected]> Signed-off-by: Paolo Bonzini <[email protected]>
- Loading branch information
Showing
1 changed file
with
20 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| QEMU README | ||
| =========== | ||
| QEMU | ||
| --- | ||
|
|
||
| QEMU is a generic and open source machine & userspace emulator and | ||
| virtualizer. | ||
|
|
@@ -31,31 +31,31 @@ version 2. For full licensing details, consult the LICENSE file. | |
|
|
||
|
|
||
| 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 | ||
|
|
||
| Complete details of the process for building and configuring QEMU for | ||
| all supported host platforms can be found in the qemu-tech.html file. | ||
| Additional information can also be found online via the QEMU website: | ||
|
|
||
| http://qemu-project.org/Hosts/Linux | ||
| http://qemu-project.org/Hosts/W32 | ||
| http://qemu-project.org/Hosts/Linux | ||
| http://qemu-project.org/Hosts/W32 | ||
|
|
||
|
|
||
| Submitting patches | ||
| ================== | ||
| --- | ||
|
|
||
| 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 | ||
| 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 | ||
| the QEMU website | ||
|
|
||
| http://qemu-project.org/Contribute/SubmitAPatch | ||
| http://qemu-project.org/Contribute/TrivialPatches | ||
| http://qemu-project.org/Contribute/SubmitAPatch | ||
| http://qemu-project.org/Contribute/TrivialPatches | ||
|
|
||
|
|
||
| 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 | ||
|
|
@@ -86,22 +86,21 @@ reported via launchpad. | |
|
|
||
| For additional information on bug reporting consult: | ||
|
|
||
| http://qemu-project.org/Contribute/ReportABug | ||
| http://qemu-project.org/Contribute/ReportABug | ||
|
|
||
|
|
||
| Contact | ||
| ======= | ||
| --- | ||
|
|
||
| The QEMU community can be contacted in a number of ways, with the two | ||
| main methods being email and IRC | ||
|
|
||
| - [email protected] | ||
| http://lists.nongnu.org/mailman/listinfo/qemu-devel | ||
| - #qemu on irc.oftc.net | ||
| - Mailing List: [email protected] | ||
| - Archives: http://lists.nongnu.org/mailman/listinfo/qemu-devel | ||
| - IRC: #qemu on irc.oftc.net | ||
|
|
||
| Information on additional methods of contacting the community can be | ||
| found online via the QEMU website: | ||
|
|
||
| http://qemu-project.org/Contribute/StartHere | ||
|
|
||
| -- End | ||