« previous next »
Pages: [1]   Go Down

Author Topic: Quality Readmes  (Read 4246 times)

0 Members and 2 Guests are viewing this topic.

SirCmpwn

  • Guest
Quality Readmes
« on: July 11, 2011, 05:53:23 pm »
Hello,
What is the best readme you've written?  I think mine is for Obstacle Snake.
« Last Edit: July 11, 2011, 05:54:18 pm by SirCmpwn »
Logged

Offline fb39ca4

  • LV10 31337 u53r (Next: 2000)
  • **********
  • Posts: 1749
  • Rating: +60/-3
    • View Profile
Re: Quality Readmes
« Reply #1 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.
« Last Edit: July 11, 2011, 06:01:46 pm by t0xic_kitt3n »
Logged

Offline ruler501

  • Meep
  • LV11 Super Veteran (Next: 3000)
  • ***********
  • Posts: 2475
  • Rating: +66/-9
  • Crazy Programmer
    • View Profile
Re: Quality Readmes
« Reply #2 on: July 11, 2011, 06:04:19 pm »
I can''t read it. How do I change the encoding?
Logged
I currently don't do much, but I am a developer for a game you should totally try out called AssaultCube Reloaded download here https://assaultcuber.codeplex.com/
-----BEGIN GEEK CODE BLOCK-----
Version: 3.1
GCM/CS/M/S d- s++: a---- C++ UL++ P+ L++ E---- W++ N o? K- w-- o? !M V?
PS+ PE+ Y+ PGP++ t 5? X R tv-- b+++ DI+ D+ G++ e- h! !r y

Offline fb39ca4

  • LV10 31337 u53r (Next: 2000)
  • **********
  • Posts: 1749
  • Rating: +60/-3
    • View Profile
Re: Quality Readmes
« Reply #3 on: July 11, 2011, 06:08:18 pm »
I know for Firefox, it is [Alt], View, Character Encoding, Unicode (UTF-16).
Logged

Offline GreenFreak

  • LV4 Regular (Next: 200)
  • ****
  • Posts: 191
  • Rating: +16/-1
    • View Profile
Re: Quality Readmes
« Reply #4 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...
« Last Edit: July 11, 2011, 06:53:57 pm by GreenFreak »
Logged

Offline Deep Toaster

  • So much to do, so much time, so little motivation
  • Administrator
  • LV13 Extreme Addict (Next: 9001)
  • *************
  • Posts: 8217
  • Rating: +758/-15
    • View Profile
    • ClrHome
Re: Quality Readmes
« Reply #5 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.
« Last Edit: December 16, 2011, 12:25:04 am by Deep Thought »
Logged



Offline ztrumpet

  • The Rarely Active One
  • CoT Emeritus
  • LV13 Extreme Addict (Next: 9001)
  • *
  • Posts: 5712
  • Rating: +364/-4
  • If you see this, send me a PM. Just for fun.
    • View Profile
Re: Quality Readmes
« Reply #6 on: July 11, 2011, 08:55:53 pm »
Logged

Offline Compynerd255

  • LV6 Super Member (Next: 500)
  • ******
  • Posts: 336
  • Rating: +53/-4
  • Betafreak Games
    • View Profile
    • Betafreak Games
Re: Quality Readmes
« Reply #7 on: July 12, 2011, 08:59:20 am »
I think that my best Readme was either for Eitrix or DIE, FIEND. The former used psuedo-sprite tricks like from the Gemini readme, and the latter was an in-depth PDF.
Logged
The Slime: On Hold, preparing to add dynamic tiles

Axe Eitrix: DONE

Betafreak Games: Fun filled games for XBox and PC. Check it out at http://www.betafreak.com


Offline Deep Toaster

  • So much to do, so much time, so little motivation
  • Administrator
  • LV13 Extreme Addict (Next: 9001)
  • *************
  • Posts: 8217
  • Rating: +758/-15
    • View Profile
    • ClrHome
Re: Quality Readmes
« Reply #8 on: July 12, 2011, 11:59:12 am »
« Last Edit: July 12, 2011, 11:59:28 am by Deep Thought »
Logged



Offline TravisE

  • LV4 Regular (Next: 200)
  • ****
  • Posts: 182
  • Rating: +33/-0
    • View Profile
    • ticalc.org
Re: Quality Readmes
« Reply #9 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
Logged
ticalc.org staff member—http://www.ticalc.org/

Offline Compynerd255

  • LV6 Super Member (Next: 500)
  • ******
  • Posts: 336
  • Rating: +53/-4
  • Betafreak Games
    • View Profile
    • Betafreak Games
Re: Quality Readmes
« Reply #10 on: July 21, 2011, 12:13:54 am »
Quote from: 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
This is a really nice readme. I almost read the whole thing, even though I don't have an 89! :)
Logged
The Slime: On Hold, preparing to add dynamic tiles

Axe Eitrix: DONE

Betafreak Games: Fun filled games for XBox and PC. Check it out at http://www.betafreak.com


Offline Munchor

  • LV13 Extreme Addict (Next: 9001)
  • *************
  • Posts: 6199
  • Rating: +295/-121
  • Code Recycler
    • View Profile
Re: Quality Readmes
« Reply #11 on: July 24, 2011, 12:17:47 pm »
Quote from: 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.

Oh yeah, that's quite good. I saw some on the contest which were also very good.
Logged

Offline Stefan Bauwens

  • Creator of Myst 89 - סטיבן
  • LV10 31337 u53r (Next: 2000)
  • **********
  • Posts: 1799
  • Rating: +162/-24
  • 68k programmer
    • View Profile
    • Portfolio
Re: Quality Readmes
« Reply #12 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
Logged


Very proud Ticalc.org POTY winner (2011 68k) with Myst 89!
Very proud TI-Planet.org DBZ winner(2013)

Interview with me

Offline Munchor

  • LV13 Extreme Addict (Next: 9001)
  • *************
  • Posts: 6199
  • Rating: +295/-121
  • Code Recycler
    • View Profile
Re: Quality Readmes
« Reply #13 on: July 24, 2011, 01:11:51 pm »
Woah, the Myst one is quite awesome!
Logged
Pages: [1]   Go Up
« previous next »