Add mardown formatting to README
cover Add mardown formatting to README
Also create README.md as a symlink to README so that github displays markdown.
Update 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.
The last time we tried, it caused issues for building installers and the check patch. Creating a symlink will hopefully avoid those.
To compare, you can take a look at the following links:
old: https://github.com/pranith/qemu/
new: https://github.com/pranith/qemu/tree/readme
Pranith Kumar (2):
Update README to accomodate markdown format
Create README.md as a symlink to README
README | 44 +++++++++++++++++++++----------------------- README.md | 1 + 2 files changed, 22 insertions(+), 23 deletions(-) create mode 120000 README.md
Signature · 1 line
2.11.0
PATCH 1/2 Update README to accomodate markdown format
--- README | 44 +++++++++++++++++++++----------------------- 1 file changed, 21 insertions(+), 23 deletions(-)
README +21 -23
@@ -1,5 +1,5 @@ - QEMU README - =========== +QEMU +==== QEMU is a generic and open source machine & userspace emulator and virtualizer.
@@ -31,22 +31,22 @@ 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 Additional information can also be found online via the QEMU website: - http://qemu-project.org/Hosts/Linux - http://qemu-project.org/Hosts/Mac - http://qemu-project.org/Hosts/W32 + - http://qemu-project.org/Hosts/Linux + - http://qemu-project.org/Hosts/Mac + - http://qemu-project.org/Hosts/W32 Submitting patches
@@ -54,7 +54,7 @@ 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
@@ -65,18 +65,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
@@ -85,22 +85,20 @@ 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 + - http://qemu-project.org/Contribute/StartHere
Signature · 1 line
2.11.0
Re: [Qemu-devel] [PATCH 1/2] Update README to accomodate markdown format
Quoted 38 lines · Pranith Kumar
Signed-off-by Pranith Kumar <[email protected]>--- README | 44 +++++++++++++++++++++----------------------- 1 file changed, 21 insertions(+), 23 deletions(-)README +7
-7@@ -1,5 +1,5 @@ - QEMU README - =========== +QEMU +==== QEMU is a generic and open source machine & userspace emulator and virtualizer.@@ -31,22 +31,22 @@ 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 Additional information can also be found online via the QEMU website:
README version 2. For full licensing details, consult the LICENSE file. · line 52
Quoted 10 lines
README +3
-3- http://qemu-project.org/Hosts/Linux - http://qemu-project.org/Hosts/Mac - http://qemu-project.org/Hosts/W32 + - http://qemu-project.org/Hosts/Linux + - http://qemu-project.org/Hosts/Mac + - http://qemu-project.org/Hosts/W32 Submitting patches
You missed this title
Quoted 51 lines
README +8
-10@@ -54,7 +54,7 @@ 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@@ -65,18 +65,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@@ -85,22 +85,20 @@ 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]
README reported via launchpad. · line 104
Quoted 10 lines
README +3
-3+ - 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 + - http://qemu-project.org/Contribute/StartHere
Much nicer now!
Nir
PATCH 2/2 Create README.md as a symlink to README
In reply to Pranith Kumar--- README.md | 1 + 1 file changed, 1 insertion(+) create mode 120000 README.md
README.md new file +1 -0
@@ -0,0 +1 @@ +README
Signature · 1 line
2.11.0