[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: [libvirt] [PATCH v2] Provide a useful README file



On Mon, May 22, 2017 at 02:00:01PM +0200, Andrea Bolognani wrote:
> On Tue, 2017-05-16 at 13:29 +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 redhat com>
> > ---
> > 
> > In v2:
> > 
> >  - Use markdown syntax
> >  - Use README.md file
> 
> My preference would be to call this README.markdown instead.

While it appears github supports both names, README.md appears
more commonly used to me - indeed github's own markup repor
uses that name

  https://github.com/github/markup/blob/master/README.md


> [...]
> > +Libvirt API for virtualization
> > +==============================
> > +
> > +Libvirt provides a portable, long term stable C API for managing the
> 
> I like using "libvirt" with a capital L consistently, even
> when it's at the beginning of a sentence. I think there might
> be style rules agains it, though.

To me it looks pretty odd to not captialize a word at the start
of the sentence.


Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]