After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 591564 - Write a README
Write a README
Status: RESOLVED FIXED
Product: gnome-shell
Classification: Core
Component: general
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gnome-shell-maint
gnome-shell-maint
Depends on:
Blocks:
 
 
Reported: 2009-08-12 13:32 UTC by Owen Taylor
Modified: 2009-09-04 19:37 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
README-file (1.87 KB, patch)
2009-09-03 21:15 UTC, nm 		none Details | Review

Description Owen Taylor 2009-08-12 13:32:10 UTC 
The README file in gnome-shell is zero length file to make automake happy. We should be non-lame and write a real one, even if it's short and doesn't do much more than point to http://live.gnome.org/GnomeShell
Comment 1 nm 2009-09-03 21:15:12 UTC 
Created attachment 142438 [details] [review]
README-file

Its a start of a README at least. Hope you would consider it anyway.
Comment 2 Owen Taylor 2009-09-04 19:29:34 UTC 
Oh, this was really meant just as a reminder to me. I didn't expect anybody would try to do it :-)

What you wrote looks quite reasonable. I decided to go with something a little different for one main reason: in my experience the more information you have in a README the more information that you'll discover hasn't been updated for years.

So I stuck to just 4 things:

 - intro paragraph (Taken from what I've been using for release announcements;
   it's a little bit more neutral and more "future-proofed" then the text
   on the Wiki.)
 - Link to the wiki
 - Pointer to bugzilla
 - license information.

You can see what I came up with:

  http://git.gnome.org/cgit/gnome-shell/plain/README

Thanks for taking a stab at this! it's really appreciated.
Comment 3 nm 2009-09-04 19:37:39 UTC 
I will check and learn from it I hope. Thanks for considering it anyway.