Hard Light Productions Forums

Off-Topic Discussion => General Discussion => Topic started by: Martinus on May 20, 2001, 05:44:00 pm

Title: Readme files
Post by: Martinus on May 20, 2001, 05:44:00 pm
I know this may seem a little frivolous to some but I've noticed that readme files that come with some mods, ships and other misc stuff are not in a standard filetype.

Basic .txt (e.g. notepad) files are ideal unless there are embedded pics, then html or .rtf (rich text) is suitable. Not everyone has a copy of word 2000, some people won't even be able to read previous versions of word files so it's common sense to make your readmes in a format that anyone can read.
I know there are various viewers available for word documents but it's a pain having to DL one just to read a single readme.

If anyone has any more bright ideas or thinks mine's dumb, speak up, it won't hurt to make things easier.

------------------
Brain over...
Insert coin
Title: Readme files
Post by: Pez on May 20, 2001, 06:14:00 pm
Can't you open Word documents (.doc) in wordpad? That works fine with me. But I agree, the best format for a readme file is .txt.

Pez
Title: Readme files
Post by: Martinus on May 20, 2001, 06:29:00 pm
Yes but only those written in wordpad (the extension is the same) or winword95 as far as I remember, anything else turns out garbled.

[This message has been edited by Maeglamor (edited 05-20-2001).]
Title: Readme files
Post by: Darkage on May 20, 2001, 07:21:00 pm
I have the dutch version of windows98 so i wordpad can't read .doc files that where written in the english version of it.There for i needed to istall MSWord97 but not every one have that kind of programs.Maby kazan or some other programers out here can make something like a universal wordpad like program so everyone can read them,even if the windows versions are completely different,and they must also include a utilitie in the program so if there are screen shots included in the readme file.I think that everyone would benefit from it (http://dynamic.gamespy.com/~freespace/ubb/noncgi/smile.gif)

------------------
               [email protected]                      
we all die but when we die we die whit spacecrack.
staff member of Soc Inferno ("http://www.3dap.com/hlp/inferno/index.html
/")
iqc 102628858
Title: Readme files
Post by: Martinus on May 20, 2001, 08:01:00 pm
HTML would be best for embedded pics. But txt still rules  (http://dynamic.gamespy.com/~freespace/ubb/noncgi/smile.gif)
Title: Readme files
Post by: Sushi on May 20, 2001, 08:23:00 pm
You're right, .txt is ideal.

1. Anyone can read it
2. Extremely small file size
3. standard convention

Good enough for me.  (http://dynamic.gamespy.com/~freespace/ubb/noncgi/smile.gif)



------------------
Sushi- the OTHER white meat!

Accelerate your game-Velocity Mod ("http://sushicw.homestead.com/files/freespace/velocity.htm")
Sushi's Freespace Zone ("http://sushicw.homestead.com/files/freespace/index.htm")-Future home of loads of cool stuff.
Title: Readme files
Post by: Jabu on May 21, 2001, 06:19:00 am
And you REALLY don't need pics for a basic readme.

readme2.html, if you want to see some pics  (http://dynamic.gamespy.com/~freespace/ubb/noncgi/smile.gif)
Title: Readme files
Post by: CobaltStarr on May 21, 2001, 11:47:00 am
Yeah just .txt or .html files would be ideal...  (http://dynamic.gamespy.com/~freespace/ubb/noncgi/smile.gif) (that way there's no way for any potentially nasty viruses to get passed around...  (http://dynamic.gamespy.com/~freespace/ubb/noncgi/biggrin.gif))