[PATCH xserver] packaging: provide a default README file #24206

[Gaetan Nadon]

On Fri, 2010-01-15 at 11:33 +1000, Peter Hutterer wrote:

> On Thu, Jan 14, 2010 at 04:08:46PM -0500, Gaetan Nadon wrote:
> > All modules should have a README file.
> > The bottom URL section is found in all X.Org README files.
> > 
> > Signed-off-by: Gaetan Nadon <memsize at videotron.ca>
> > ---
> >  README |   34 ++++++++++++++++++++++++++++++++++
> >  1 files changed, 34 insertions(+), 0 deletions(-)
> >  create mode 100644 README
> > 
> > diff --git a/README b/README
> > new file mode 100644
> > index 0000000..18deee9
> > --- /dev/null
> > +++ b/README
> > @@ -0,0 +1,34 @@
> > +					X Server
> > +
> > +The X server accepts requests from client applications to create windows,
> > +which are (normally rectangular) "virtual screens" that the client program
> > +can draw into.
> > +
> > +Windows are then composed on the actual screen by the X server
> > +(or by a separate composite manager) as directed by the window manager,
> > +which usually communicates with the user via graphical controls such as buttons
> > +and draggable titlebars and borders.
> > +
> > +All questions regarding this software should be directed at the
> > +Xorg mailing list:
> > +
> > +        http://lists.freedesktop.org/mailman/listinfo/xorg
> > +
> > +Please submit bug reports to the Xorg bugzilla:
> > +
> > +        https://bugs.freedesktop.org/enter_bug.cgi?product=xorg
> > +
> > +The master development code repository can be found at:
> > +
> > +        git://anongit.freedesktop.org/git/xorg/xserver
> > +
> > +        http://cgit.freedesktop.org/xorg/xserver
> > +
> > +For patch submission instructions, see:
> > +
> > +	http://www.x.org/wiki/Development/Documentation/SubmittingPatches
> > +
> > +For more information on the git code manager, see:
> > +
> > +        http://wiki.x.org/wiki/GitPage
> > +
> > -- 
> > 1.6.0.4
> > 
> > Resending for review.
> > This is a starter. It can be improved through additional patches.
> > The description was copied from distro docs.
> 
> Reviewed-by: Peter Hutterer <peter.hutterer at who-t.net>
> 
> Does this need to go into the Makefile.am or is this picked up as a default
> file?
> 

Checked-in git. The word "default" means that it is a minimum file and
contains the "default" section with the URLs which all README contains
for consistency.


> also, I wonder if we should just link to wikipedia's articles to avoid
> having to actually describe what the X server is :)
> http://en.wikipedia.org/wiki/X_server should answer any questions the first
> two paragraphs leave open.

This was the first place I looked for a short, focused description of
the X server. I was not satisfied with it, personal opinion. However,
the link is a great addition. I will add and resubmit. I'd like to get
the file in, it's the third post. It can be improved thereafter.

Thanks for the review.

> Cheers,
>   Peter
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.x.org/archives/xorg-devel/attachments/20100115/3223120e/attachment.html