http://calcg.org/newlogo2.png Not Logged in.
Login | Register

General Discussion Board \ Site \ ReadMe Stuff

Click here to log in (you must be logged in to post comments).

AuthorComment
JcCorp
Probe
Posted: 29 Jan 2005
09:42 GMT
Total Posts:

Edit
One thing I really hate is downloading a game and seeing either no readme or a completely useless one. So, because I have time, I will list things that should go into a readme. Any extra stuff is pretty much up to the writer.

1. A bit of info about what the game actually does, or what each file does.
2. Some sort of instructions, so no one gets lost.
3. FAQs are nice.
4. All contributors to the files.
5. A list of thank-yous. Maybe let your local archiver (M) know his work is appreciated.
6. Version history is always cool, just make sure there ARE past versions.
7. ASCII graphics look nice. Put 'em in if you can.
8. Hints, cheats, and email addresses for those who are stuck
9. Organization is very handy. Try to put in a table of contents, or at least different sections.

Humor can also be used to make it more enjoyable. Here's what Dan (my little brother) typed up in BobGame4:

>=Q&A:
>
>Q:Who is Bob? Is he based on a real person?
>A:Just your average person with an abnormal intelligence (or lack thereof). Yes, you (No).
>
>Q:What is the purpose to this game?
>A:To amuse and confuse (Hey, that rhymes!).
>
>Q:Are there any secrets (like easter eggs) located in the game?
>A:One; Hit ON whenever you want to find the "hidden menu" with two >options.
>
>Q:Do you want fries with that?
>A:No. Yes. Sometimes?
>
>Q:Are you going to answer any real questions that need to be answered?
>A:Never.

It then goes on to answer decent questions, I think.

Oh, and you don't HAVE to be n00b-friendly. That's what Ray Kremer's FAQ & the visual guide are for.

I hope this will help make the files in the archive more understandable.

[Edited by JcCorp on 29-Jan-05 18:44]
Xero Xcape
Marine
avatar
Posted: 31 Jan 2005
07:12 GMT
Total Posts: 29
since my games use List files to save I accually tell people how to cheat using the lists... step by step

---
BASIC flames are for n00bs, you don't want to be a n00b do you? | My other calc is a Porsche.
darksideprogramming
Guardian
avatar
Posted: 31 Jan 2005
19:26 GMT
Total Posts: 1005
Well, Jc, you've done it again:

made yourself useful :D

But that is a good point. I despise this as well.
TI Freak
Probe
Posted: 1 Feb 2005
06:40 GMT
Total Posts:

Edit
Like you, I dislike bad readmes, though I hate bad reviews even worse. If someone is going to review, and their is something in the game they don't like (i.e. give low points for) they should at least give a suggestion on how to make it better.
JcCorp
Probe
Posted: 1 Feb 2005
14:13 GMT
Total Posts:

Edit
I was recently "upgraded" to Content Manager, so I added this in the guidelines section too.
Morgan
Ultralisk
Posted: 2 Feb 2005
01:07 GMT
Total Posts: 321
I recently updated all the readme's that came with my Physics programs over at ticalc and since then I still get people withqiestions on how to run them even though I explained step by step how to run the program using any method I could think of....I thunk I am about to give up :-/
Ray Kremer
Ultralisk
Posted: 2 Feb 2005
08:30 GMT
Total Posts: 310
You can lead a horse to water...
darksideprogramming
Guardian
avatar
Posted: 2 Feb 2005
17:31 GMT
Total Posts: 1005
*sigh*

Some people's kids...
Lunchbox
Carrier
avatar
Posted: 2 Feb 2005
17:42 GMT
Total Posts: 2007
Some people are just so stupid they can't understand the calculator or how to use its software, no matter how user-friendly it is. I, personally, have to explain how a to use the TI-83+ calculator at least once a day, and how to program it almost as often. I think the worst question i've been asked a majority of times is "How do I make a game?". Mainly because making a game requires independent intellect. Sorry for geetting off topic, but I just needed to express that. Anyways, i agree w/ JC. theere's hardly anything worse than a game with no readme or a bad one. That's why I always try to givee a fair description of my programs in my readmes.
Ray Kremer
Ultralisk
Posted: 3 Feb 2005
09:04 GMT
Total Posts: 310
>I think the worst question i've been asked a majority of times is "How
>do I make a game?". Mainly because making a game requires independent
>intellect.

Quoted for great truth.
Morgan
Ultralisk
Posted: 3 Feb 2005
10:49 GMT
Total Posts: 321
As well knowledged people from the TI community I don;t think we should be telling them as much as showing them. I know that is kind of hard when all we can do is write words for them to read. However when in person and someone asks me something about their calc, I never press a single button, I simply ask them to try it first and guide them through it withiout telling them word for word what to do. They will learn more that way and are less likely to need more help.

However yes this is hard to do over the internet, which is why I updated my readme's, but whenever possible I try to make them do as much of it as possible. Heck I even used that approach with my first girlfriend and to my surprize she actually made a program one day!!!
Morgan
Ultralisk
Posted: 3 Feb 2005
10:50 GMT
Total Posts: 321
I think the internet equilivent of showing somebody how to do it like I emntioned about would be pointing them to FAQ's and such so they can start to find the answers they desire on their own.
TI Freak
Probe
Posted: 4 Feb 2005
05:25 GMT
Total Posts:

Edit
I have the same problem, people always wanting to know how to program, so I said to heck with it, and I have started creating tutorials on my site. When I get them done, I can just start pointing people to them... :D





Portal | My Account | Register | Lost Password or Username | TOS | Disclaimer | Help | Site Search | File Archives Copyright © 2002-2019 CalcG.org