PDA

View Full Version : Readme File Format: PDF, Word, etc...


The Source
10-28-2005, 09:51 AM
Readme File Format: PDF, Word, etc...
I know I asked this several months ago, and I cannot find the thread. However, I have been working on the readme file, and found that it would be hard to seperate categories with a primitive text application. Other words, you can't make the fonts stand out, so you know important headings and subheadings. Since my readme file is five pages long, I need to create a hirearchy of importance.

My question:
Would it be wise to create a readme file in:
MS Word?
PDF Format?
Browser Format?
Etc...

Your thoughts?

Pavlos
10-28-2005, 10:01 AM
I'd prefer it to be in just a .txt as it opens faster even on my AMD Athlon 64 3400+ with 1Gb of ram word still takes a longer time to load up than a .txt file. I like speed! I don't want to wait around! But pdf looks better. But I'd have to stick with .txt

Fred Tetra
10-28-2005, 10:19 AM
You could write your file in RTF, which allows you to use various font faces and sizes, bold and italic styles, etc. It is somewhat slower to open than straight ASCII text, but nowhere near as slowly as PDF. Both WordPad and MS Word can read/write this format.

HTML is a good second choice, especially if you need tables or embedded images.

Det. Bart Lasiter
10-28-2005, 04:31 PM
HTML (or whatever you use for web pages), would be a good choice, as pretty much anyone can open them.

Darth333
10-28-2005, 04:37 PM
Yes, html is definitely a good choice as well as .txt and .rtf as everyone can view them. Don't go fancy with .pdf and .doc. Readmes should be easy to use and quick to open. You're distributing a game mod, not the whole game, so keep it simple and practical ;)

Unless the readme is relatively short, I like to use html as it allows you to make an index and link to the various topics in your readme.

Fred Tetra
10-28-2005, 05:07 PM
Believe me, make it as easy as possible; even though Kotor Tool has a text-based readme file, people *still* ask questions that are answered in it! :)

Pavlos
10-28-2005, 05:16 PM
:angel: I didn't ask any questions, honest.

Darth333
10-28-2005, 05:29 PM
I guess the only solution to this would be to change the title from readme.txt to kotor3_confirmed.txt or free_money.txt :p

Pavlos
10-28-2005, 05:32 PM
kotor3_confirmed, you shouldn't use those words around here, you will get 5000 threads appearing about how it has been confirmed. :)

Darth InSidious
10-28-2005, 06:37 PM
You just said it!



AAAH! I said the word!
:xp:

If you ask my opinion, a .txt is the way to go....

svösh
10-28-2005, 07:55 PM
LOL who cares unfortunately most people never read it anyways :rolleyes:
On average most pm’s I get ask me questions I have answered or stated in my read me's.

It’s about as annoying as some one complaining they can do a better job then your mod
Yet have never touched the tools and have zero know how in computers or any of the game editing disciplines
But still complain about the work you did for free .. and have the nerve to not read about the mod.

For some thing that long I would say .RTF as well, every windows user has wordpad and it’s not as
much of a hog as MS word is and you can change font faces size and all that formatting jazz ;)

svösh

Mono_Giganto
10-29-2005, 12:11 AM
Heh, if I can find the time to finish old projects, I'm naming my readme's free_money.rtf from now on. Thanks for the idea. :D

RedHawke
10-29-2005, 02:27 AM
Mac, I'd say go with rtf or html... but that's just me! :D

Though I too am tempted to use free_money.rtf on my next readme as well! ;)

On average most pm’s I get ask me questions I have answered or stated in my read me's.
Same here, it is amazing the number of people who ignore the readme files.

It’s about as annoying as some one complaining they can do a better job then your mod
Yet have never touched the tools and have zero know how in computers or any of the game editing disciplines
But still complain about the work you did for free .. and have the nerve to not read about the mod.
*Nods head in agreement*

Darth InSidious
10-29-2005, 09:54 AM
LOL who cares unfortunately most people never read it anyways :rolleyes:
On average most pm’s I get ask me questions I have answered or stated in my read me's.

It’s about as annoying as some one complaining they can do a better job then your mod
Yet have never touched the tools and have zero know how in computers or any of the game editing disciplines
But still complain about the work you did for free .. and have the nerve to not read about the mod.

For some thing that long I would say .RTF as well, every windows user has wordpad and it’s not as
much of a hog as MS word is and you can change font faces size and all that formatting jazz ;)

svösh
That's why my mod description on pcgm is always the same as the readme ;)

Mono_Giganto
10-29-2005, 01:21 PM
Yeah, same here, now, if I get a question I already answered, I just reply with a link to the description.

svösh
10-30-2005, 11:44 PM
You guys go with freemoney.txt i'll go with sex.txt see who gets less questions in pm's :p

lol it’s marketing 101 sex sells

svösh

Mono_Giganto
10-30-2005, 11:45 PM
You guys go with freemoney.txt i'll go with sex.txt see who gets less questions in pm's :p

lol it’s marketing 101 sex sells

svösh

svösh wins.

Prime
10-31-2005, 11:39 AM
I think a simple text document is enough, but you can always be fancy and use HTML. Remember, it is the content that counts!

Darkkender
10-31-2005, 11:59 AM
svösh wins.

I 2nd that statement.

General Kenobi
10-31-2005, 03:31 PM
Since my readme file is five pages long, I need to create a hirearchy of importance.


Why on top of God's green earth do you possibly need a 5 page readme.txt? :confused:

"This MOD mine" "NO copy without ask" would be good enough ;)

Just curious

:ben:
General Kenobi

Darth333
10-31-2005, 03:48 PM
I think you should try to keep it simple inasmuch as possible. The only time I had a long readme was for the AIOFPM mod for kotor 1 where I included descriptions of all the mods. I found .html very practical for this. Here it is if you want to have a look at it: sex_and_money.zip ( http://lucasforums.com/attachment.php?attachmentid=2278) (had to zip it because LF does not accept .html attachments)