# .txt on README?

**URL:** <https://www.ruby-forum.com/t/txt-on-readme/118657>\
**Category:** Ruby\
**Created:** [October 29, 2007, 9:07pm UTC](https://www.ruby-forum.com/t/txt-on-readme/118657 "2007-10-29T21:07:32Z")\
**Posts on this page:** 6\
**Page:** 1

<div class="post-metadata">

**Author:** ![Trans](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/dfb087/32.png) [@Trans](https://www.ruby-forum.com/u/Trans)\
**Post date:** [October 29, 2007, 9:07pm UTC](https://www.ruby-forum.com/t/txt-on-readme/118657/1 "2007-10-29T21:07:32Z")

</div>

I’m curious about use the .txt extension on README. I know Hoe does  
this. Why? Is this just to make it easier for Windows developers? Or  
is there some other reason?

T.

---

<div class="post-metadata">

**Author:** ![Trans](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/dfb087/32.png) [@Trans](https://www.ruby-forum.com/u/Trans)\
**Post date:** [October 30, 2007, 2:07am UTC](https://www.ruby-forum.com/t/txt-on-readme/118657/2 "2007-10-30T02:07:33Z")

</div>

On Oct 29, 2007, at 4:06 PM, Trans wrote:

> I’m curious about use the .txt extension on README. I know Hoe does  
> this. Why? Is this just to make it easier for Windows developers? Or  
> is there some other reason?

Not just Windows. The Mac OS X Finder recognizes the txt extension.

Regards, Morton

---

<div class="post-metadata">

**Author:** ![Trans](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/dfb087/32.png) [@Trans](https://www.ruby-forum.com/u/Trans)\
**Post date:** [October 30, 2007, 2:58am UTC](https://www.ruby-forum.com/t/txt-on-readme/118657/3 "2007-10-30T02:58:57Z")

</div>

Quoth Morton G.:

> On Oct 29, 2007, at 4:06 PM, Trans wrote:
> 
> > I’m curious about use the .txt extension on README. I know Hoe does  
> > this. Why? Is this just to make it easier for Windows developers? Or  
> > is there some other reason?
> 
> Not just Windows. The Mac OS X Finder recognizes the txt extension.
> 
> Regards, Morton

Surely It’s not just about recognition? Linux graphical file-explorers  
(Nautilus, Konqueror, etc) recognise the ‘.txt’ extension, but it isn’t  
required.

Regards,

---

<div class="post-metadata">

**Author:** ![Trans](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/dfb087/32.png) [@Trans](https://www.ruby-forum.com/u/Trans)\
**Post date:** [October 30, 2007, 4:15pm UTC](https://www.ruby-forum.com/t/txt-on-readme/118657/4 "2007-10-30T16:15:48Z")

</div>

On Oct 29, 2007, at 2:06 PM, Trans wrote:

> I’m curious about use the .txt extension on README. I know Hoe does  
> this. Why? Is this just to make it easier for Windows developers? Or  
> is there some other reason?

Hoe is using regexp patterns to select files to include in the gem.  
One of those patterns includes all files with a .txt extension.  
Putting .txt onto the end of the README is easier than creating a  
special regexp case for all files like README, History, Manifest, etc.

This falls under the “sloth” rule from Larry Wall.

Blessings,  
TwP

---

<div class="post-metadata">

**Author:** ![Trans](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/dfb087/32.png) [@Trans](https://www.ruby-forum.com/u/Trans)\
**Post date:** [October 30, 2007, 6:12pm UTC](https://www.ruby-forum.com/t/txt-on-readme/118657/5 "2007-10-30T18:12:28Z")

</div>

On Oct 30, 11:00 am, Tim P. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:

> This falls under the “sloth” rule from Larry Wall.

Ah, I see. Thanks for explaining. I just wanted to makes sure I wasn’t  
missing any crucial aspect of cross-platform support b/c of it. If  
it’s just a Hoe “slothy” thing, then I think I’m okay. I just use [A-  
Z]\*, and have a config option for any special exclusions.

Thanks,  
T.

---

<div class="post-metadata">

**Author:** ![Trans](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/dfb087/32.png) [@Trans](https://www.ruby-forum.com/u/Trans)\
**Post date:** [October 30, 2007, 6:25am UTC](https://www.ruby-forum.com/t/txt-on-readme/118657/6 "2007-10-30T06:25:48Z")

</div>

Konrad M. wrote:

> Surely It’s not just about recognition? Linux graphical file-explorers  
> (Nautilus, Konqueror, etc) recognise the ‘.txt’ extension, but it isn’t  
> required.
> 
> ## Regards,
> 
> Konrad M. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) [http://konrad.sobertillnoon.com/](http://konrad.sobertillnoon.com/)

I think any decent file management program should use both MIME and  
.extension. I know KDE/Konqueror does this but I think Windows is more  
concerned with the .txt and skips looking at the text/plain mime type  
but I’ve  
never really had cause to screw with file associations under Windows NT  
 → I  
just right click and open with vim it 🙂

By default I assume files without extensions are text files (UTF-8, ISO  
8859-x, ASCII). If it’s full of garbage I know it’s binary. When in  
doubt I  
just use file(1) since it’s used in just about every Linux and BSD  
system out  
there and has a Windows port as well.

TerryP.

PS: Yes I do prefer my unix shell to file managers.
