[virt-tools-list] [PATCH virt-viewer 2/2] README: switch to Markdown syntax

Pavel Grunt pgrunt at redhat.com
Thu Jan 19 15:29:41 UTC 2017


On Thu, 2017-01-19 at 16:12 +0100, Fabiano Fidêncio wrote:
> On Thu, Jan 19, 2017 at 1:17 PM, Pavel Grunt <pgrunt at redhat.com>
> wrote:
> > To render nicely on the project git page:
> >  https://pagure.io/virt-viewer
> > ---
> >  README => README.md | 5 +----
> >  1 file changed, 1 insertion(+), 4 deletions(-)
> >  rename README => README.md (97%)
> > 
> > diff --git a/README b/README.md
> > similarity index 97%
> > rename from README
> > rename to README.md
> > index ea1c633..f51b9b4 100644
> > --- a/README
> > +++ b/README.md
> > @@ -1,5 +1,4 @@
> > -  Virt Viewer
> > -  ===========
> > +# Virt Viewer
> > 
> >  Virt Viewer provides a graphical viewer for the guest OS
> >  display. At this time is supports guest OS using the VNC
> > @@ -38,5 +37,3 @@ found on the Virt Manager website:
> >  Feedback should be directed to the mailing list at
> > 
> >    http://www.redhat.com/mailman/listinfo/virt-tools-list
> > -
> > --- End
> > --
> > 2.11.0
> > 
> > _______________________________________________
> > virt-tools-list mailing list
> > virt-tools-list at redhat.com
> > https://www.redhat.com/mailman/listinfo/virt-tools-list
> 
> Pavel,
> 
> I'm not against switching to Markdown syntax, but I'd like go to for
> it entirely in case we're doing this.
> What does it mean? It means also use markdown for: links,
Do you mean to mark all libvirt, spice-gtk and other stuff as links ?

>  configure
> options (mark them as code)
makes sense

> , maybe emphasis on what we depend and so on.
> 
> Does the comment make sense?

sure, it does.

btw: one can see how it is rendered on my fork
 https://pagure.io/fork/pgrunt/virt-viewer

Thanks,
Pavel


> 
> Best Regards,




More information about the virt-tools-list mailing list