[libvirt] [PATCH] Provide a useful README file

Martin Kletzander mkletzan at redhat.com
Tue May 16 11:54:30 UTC 2017


On Tue, May 16, 2017 at 11:50:27AM +0100, Daniel P. Berrange wrote:
>The current README file contents has almost no useful info, and that
>which does exist is very outdated.
>
>Signed-off-by: Daniel P. Berrange <berrange at redhat.com>
>---
> README | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++---------
> 1 file changed, 71 insertions(+), 10 deletions(-)
>

This is great and all, but if we are making this better, why not take
the opportunity to use some plaintext format that has few features?  I,
personally, don't care whether that's org, markdown or rst.  Just
something that is still usable and readable as a plaintext file while it
can be nicely formatted (with headers, links and images) on pages that
support it (e.g. github).  I know this seems like stupid wannabe modern
tiny thing, but there are many nuances that can potentially influence
future contributors.  And I think this is one of the positive ones.

Martin
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: Digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20170516/afdd2992/attachment-0001.sig>


More information about the libvir-list mailing list