Omnimaga

General Discussion => Other Discussions => Miscellaneous => Topic started by: SirCmpwn on July 11, 2011, 05:53:23 pm

Title: Quality Readmes
Post by: SirCmpwn on July 11, 2011, 05:53:23 pm
Hello,
What is the best readme you've written?  I think mine is for Obstacle Snake (http://www.ticalc.org/cgi-bin/zipview?83plus/asm/games/obstacle_snake.zip;readme.txt).
Title: Re: Quality Readmes
Post by: fb39ca4 on July 11, 2011, 06:01:27 pm
It was mostly unreadable for me, until I realized I should change the encoding to UTF-16 :P That was a very well written readme.
Title: Re: Quality Readmes
Post by: ruler501 on July 11, 2011, 06:04:19 pm
I can''t read it. How do I change the encoding?
Title: Re: Quality Readmes
Post by: fb39ca4 on July 11, 2011, 06:08:18 pm
I know for Firefox, it is [Alt], View, Character Encoding, Unicode (UTF-16).
Title: Re: Quality Readmes
Post by: GreenFreak on July 11, 2011, 06:49:41 pm
wow! looks very nice ;) I like the title and the imitated "screenshot" :) (I don't know, how to say that :P )

I never made my own ReadMe...
Title: Re: Quality Readmes
Post by: Deep Toaster on July 11, 2011, 08:16:42 pm
The screenshot (textshot?) is awesome :D

My readmes always suck, but they've gotten progressively better. Right now I have a readme_template.txt saved on root that I copy into every new readme I make:

Quote
========    CONTACT    ========

Made by Deep Thought ([email protected])
            a member of

    Omnimaga Coders of Tomorrow
        http://www.omnimaga.org/
        The most hyperactive forum around. Join us in #omnimaga on EFnet!

    Revolution Software
        http://www.revsoft.org/
        Seven years and counting, and still home to so many amazing projects.

    ClrHome Productions
        http://clrhome.org/
        Come here for suggestions and bug reports. Or just for the heck of it.

I'm still trying to find ideas for what else I should put in there.
Title: Re: Quality Readmes
Post by: ztrumpet on July 11, 2011, 08:55:53 pm
I think mine was my one for Drifter: http://www.ticalc.org/cgi-bin/zipview?83plus/basic/games/puzzle/sliding/drifter.zip;Read%20Me.txt
Title: Re: Quality Readmes
Post by: Compynerd255 on July 12, 2011, 08:59:20 am
I think that my best Readme was either for Eitrix (http://www.ticalc.org/archives/files/fileinfo/436/43633.html) or DIE, FIEND (http://www.ticalc.org/archives/files/fileinfo/424/42483.html). The former used psuedo-sprite tricks like from the Gemini readme, and the latter was an in-depth PDF.
Title: Re: Quality Readmes
Post by: Deep Toaster on July 12, 2011, 11:59:12 am
I think mine was my one for Drifter: http://www.ticalc.org/cgi-bin/zipview?83plus/basic/games/puzzle/sliding/drifter.zip;Read%20Me.txt

Nice, you used graphics, like SirCmpwn. ASCII++ :D
Title: Re: Quality Readmes
Post by: TravisE on July 14, 2011, 01:05:47 pm
This was a readme that I always thought turned out particularly nice for a fairly simple TI-89 RPG-ish fight simulator:
http://www.ticalc.org/cgi-bin/zipview?89/basic/games/rpg/battle/rpgfight.zip;RPGFight_0.10.00/rpgfight.txt

Readmes for most of my other programs use this same general style since I like consistency.

I've had a history of being (sometimes excessively) prolific with writing as well as having an unusual enjoyment of reading manuals, so my readmes tend to be looong. :D
Title: Re: Quality Readmes
Post by: Compynerd255 on July 21, 2011, 12:13:54 am
This was a readme that I always thought turned out particularly nice for a fairly simple TI-89 RPG-ish fight simulator:
http://www.ticalc.org/cgi-bin/zipview?89/basic/games/rpg/battle/rpgfight.zip;RPGFight_0.10.00/rpgfight.txt

Readmes for most of my other programs use this same general style since I like consistency.

I've had a history of being (sometimes excessively) prolific with writing as well as having an unusual enjoyment of reading manuals, so my readmes tend to be looong. :D
This is a really nice readme. I almost read the whole thing, even though I don't have an 89! :)
Title: Re: Quality Readmes
Post by: Munchor on July 24, 2011, 12:17:47 pm
Hello,
What is the best readme you've written?  I think mine is for Obstacle Snake (http://www.ticalc.org/cgi-bin/zipview?83plus/asm/games/obstacle_snake.zip;readme.txt).

Oh yeah, that's quite good. I saw some on the contest which were also very good.
Title: Re: Quality Readmes
Post by: Stefan Bauwens on July 24, 2011, 01:03:27 pm
I think the one I made for Myst was quite well: http://stefan.bwns.be/myst/readme.html
Al though, some (big) parts are from the original manual.
I also think this one of Holes, Blocks and Ladders is quite ok: http://www.ticalc.org/cgi-bin/zipview?89/basic/games/puzzle/hbl.zip;hbl/readme.txt
Title: Re: Quality Readmes
Post by: Munchor on July 24, 2011, 01:11:51 pm
Woah, the Myst one is quite awesome!