README or README.txt?

Posted by Uwe Hermann on October 12, 2004 at 10:22pm

I just checked how often the filenames README (213) and README.txt (44) appear in the contrib CVS.

I'd like to see a common naming convention for text-files, not only README, but also INSTALL, LICENSE etc. IMHO all files in core as well as in contrib should either have ".txt" appended or not - but consistently.

My question is, what should we be using? README is the standard on Unix/Linux systems, README.txt might be simpler to open and more common on Windows boxes. Personally I don't care much, but IMHO we should establish a standard naming convention here...

Thoughts?

Comments

README.txt

Posted by ax on October 12, 2004 at 10:31pm

core drupal's txt-files were renamed some time ago to have .txt-extensions, and so should contrib modules. mind to update the contrib http://cvs.drupal.org/viewcvs/contributions/ README.txt (and FAQ.txt) and possibly the contributions book page?

Done.

Posted by Uwe Hermann on October 13, 2004 at 10:34am

I have updated FAQ.txt and README.txt in CVS. It seems like I don't have permissions to update the book page(s), at least I can't spot an "edit" link/tab anywhere...

This page http://drupal.org/node/321 was written by you, maybe you can update it? I guess you should have the correct permissions.

Uwe.
--
My Drupal site: http://www.crazy-hacks.org
Soon to be drupalized: http://www.unmaintained-free-software.org

--
hermann-uwe.de

done

Posted by ax on October 13, 2004 at 3:58pm

(the book page). thanks for doing the rest.

README.txt

Posted by Dries on October 13, 2004 at 5:47am

Feel free to update the contributions repository.

Done for all README files. LI

Posted by Uwe Hermann on October 13, 2004 at 1:10pm

Done for all README files. LICENSE, CHANGELOG etc. will follow soon.
Shall I add an entry "file naming conventions" or similar to CODING_STANDARDS.html?

Uwe.
--
My Drupal site: http://www.crazy-hacks.org
Soon to be drupalized: http://www.unmaintained-free-software.org

--
hermann-uwe.de

Notification

Posted by JonBob on October 13, 2004 at 1:57pm

Having such changes made without notifying the development list concerns me. I've written a post to the list expressing this more clearly. Thanks for the cleanup, though.

CODING_STANDARDS.html

Posted by ax on October 13, 2004 at 4:08pm

i would very welcome such an entry in CODING_STANDARDS.html. this file hasn't been maintained and updated very well, so it could need some review and makeover anyway. one example that i often thought should go there is string syntax (' vs. " vs. <<<EOD). we have been replacing "s with 's for constant strings for some time now (watch the cvs messages), but this has never been documented. and it even is wrong in CODING_STANDARDS.html.

mind to work on that while you are at it? if so, you might consider a message to the devel list before :)