Pocket Plane Group
Friends and Neighbors => Weimer Republic (WeiDU.org) => WeiDU => Topic started by: WizWom on August 27, 2006, 07:31:32 AM
-
The documentation packaged with WeiDU is in TEX format.
WTF? Why? It's not like you're going to be typesetting anything in there, let alone mathematical formulae.
PLEASE SOMEWHERE... anywhere - put up documentation is a decent format; I really don't want to bother downloading and installing a TEX layout program for a single bloody stupid app.
-
Documentation in html format (http://www.weidu.org/~thebigg/README-WeiDU.html). This has been packaged with WeiDU for as long as I've been using it.
-
Wasn't in my .192 source distribution.
-
I'm pretty sure it's in both SRC and binary distributions.
-
I'm pretty sure it's in both SRC and binary distributions.
It's definitely in both versions of 195.
-
OK, found it - README-Weidu.html is not DOCUMENTATION-WeiDU.html. A README is for describing possible issues with installation and running the product. Not for a functional description of the product.
Goofball foreigners :-)
-
are you the funny?
-
Goofball foreigners :-)
I'm pretty sure Wes is, like your profile suggests you are, American.
-
I'm pretty sure Wes is, like your profile suggests you are, American.
BUT I AM ITALIAN, SO IT MUST BE MY FAULT!!!11111111
-
ummm... I think for documentation (i.e. standard reference materials regarding base installation and usage of freely distributed programs, etc.) the "modern" (read that as anything past 1988 or 1989) approach is to assume user stupidity:
1 file, usually txt or htm, labelled ReadMe (Because older Dos file structures didn't allow for filenames like YoStupidIdiotYouNeedToReadThisBeforeYouTrashYourWholeSystemAndComeCryingToMe.txt, and when the user looks at the directory structure or file folder it stands out and screams "Read ME!!!") which includes all pertinent documentation including technical definitions, documentation of usage, installation instructions, etc; Games differ slightly from programs by sometimes including a "walkthrough" or "FAQ".
I have not seen "documentation" separated. In fact, it looks like (and I am now using) the wave of the future is "readMe as interlinked html or xml based web archive", where the ReadMe is a table of contents linking to either in-document anchors or related pages; a one-stop-shop for all information related to the program.
Pardon me if I appear pendantic and lecturing... but as a true Taxpayin' UN-Hatin' Gun Totin' World Conkerin' Amurukun Dude, I just had to make sure our side of the Big Pond was getting the facts straight :)
Although we all know it is a big Italian Conspiracy to rule the world by hiding important information on World Domination Through WeiDU Distribution from us US users. And if I recall correctly, Wes can't be truly called American... he's from California, which everybody knows is a world (or universe) unto itself! ;D