Feature request: add a readme file

[GoogleCodeExporter]

Just read the title.  This emulator is great, but some people are new to 
emulation, and are probably gonna need some help with this.  A readme file 
never hurts, and I always read the readme file that come with online downloads 
(almost always).  Emulators are no exception.

I am very willing to make a readme if no one else wants to.

Original issue reported on code.google.com by hookonso...@gmail.com on 16 Jul 2010 at 6:54

[GoogleCodeExporter]

readme for 1.03 is still mostly valid.

Original comment by danialho...@gmail.com on 17 Jul 2010 at 6:39

[GoogleCodeExporter]

That may be so, but there are some new things, and those things should be 
updated.

Original comment by hookonso...@gmail.com on 17 Jul 2010 at 7:44

[GoogleCodeExporter]

http://pastebin.com/aeAPTNRz

Original comment by danialho...@gmail.com on 20 Jul 2010 at 4:03

[GoogleCodeExporter]

So we can now update the readme as we see fit?  Nice!

I'll be sure to update some things and make it better.

Original comment by hookonso...@gmail.com on 20 Jul 2010 at 6:57

[GoogleCodeExporter]

I have added a fix for the syscall.bin and ip.bin BIOS problem on this 
documentation.

I really suggest to put it on the compilation as readme.txt or documentation.txt

Original comment by lordevilfiles@gmail.com on 5 Aug 2010 at 9:38

[GoogleCodeExporter]

http://pastebin.com/83bGs4CG << Documentation updated

(sorry, forget to put the link)

Original comment by lordevilfiles@gmail.com on 5 Aug 2010 at 10:20

[GoogleCodeExporter]

Just don't bother updating the thing. I'll probably take care of it when the 
time comes for a stable/beta release (svn snapshots do not count as beta nor 
stable).

Not to mention that those two last files are neither needed, nor have anything 
to do with the Dreamcast BIOS files.

Original comment by Mr.PsyMan on 6 Aug 2010 at 1:53

[GoogleCodeExporter]

Well, we need a proper readme psy (HTML or smth, nobody likes text files these 
days).

Or maby code a guide/wizzard on the emu :p

Original comment by drkIIRaziel on 6 Aug 2010 at 3:58

[GoogleCodeExporter]

I can code it on html if you want...

I don't know C++, so I can't help to put on the emu...

Original comment by lordevilfiles@gmail.com on 6 Aug 2010 at 9:31

[GoogleCodeExporter]

If nobody likes TXT files these days... how about NFO?
Still, the README.TXT is a classic. :)

Original comment by KrossX3 on 7 Aug 2010 at 12:32

[GoogleCodeExporter]

If nobody likes TXT files these days... how about NFO?

LOL!

I still don't understand why they use NFO... it's because that .txt don't 
support the characters?

Yah, readme.txt is classic, but I think is better on an about box or on the 
website...

Original comment by lordevilfiles@gmail.com on 7 Aug 2010 at 1:09

[GoogleCodeExporter]

NFO files can be treated by some editors/viewers with white text on black 
background. Both are the same though, mere text files. You could just change 
the extensions if you want. XD

There aren't many plugins or BIOS to make a Wizard ala ePSXe for example. And 
if there's a BIOS problem, DirectX or Runtimes problems... the emu won't run, 
and the user won't see the Readme/Wizard anyway. =P

On a website, if you suddenly have no internet for whatever reason, the readme 
becomes unreadable. In the case of having a website, with a readme updated, 
including a copy of it (HTML) on the package would be nice.

Either keep the simple text file, or a simple HTML readme should be fine I 
think.

Original comment by KrossX3 on 7 Aug 2010 at 8:57

[GoogleCodeExporter]

Yeah yeah, you have convinced me...

I think is better to put a copy of the html on the package... a lot of people 
never reads readme.txt - put an manual.html is better in almost all ways...

Original comment by lordevilfiles@gmail.com on 7 Aug 2010 at 9:45

[GoogleCodeExporter]

Still, a readme.txt still gets some people's attention.  I'd be more than 
willing to make a readme.txt.

Original comment by hookonso...@gmail.com on 9 Aug 2010 at 2:38

[GoogleCodeExporter]

I've brought this one up again as we're still getting new issues on the tracker 
regarding basic requirements errors such as not installing Visual C++ 2010 or 
updating DirectX. I really think we should just stick a readme.txt in the 
current distribution to cut these down.

I've attached a readme file that I've put together by updating the 1.0.3 
readme. Can someone review it and put it in subsequent builds please? We can 
work on a better/prettier solution later.

Original comment by matbur...@gmail.com on 4 Sep 2010 at 2:45

Attachments:

• [readME nullDC 1.0.4.txt](https://storage.googleapis.com/google-code-attachments/nulldc/issue-166/comment-15/readME nullDC 1.0.4.txt)

[GoogleCodeExporter]

They won't read it. So you would have the same issues, but spammed with "Read 
the ReadMe" replies.

Original comment by KrossX3 on 4 Sep 2010 at 4:21

[GoogleCodeExporter]

Some people will, you can't vouch for everyone.

It must be better to have a readme in there than not at all, where's the harm?

Original comment by matbur...@gmail.com on 4 Sep 2010 at 4:45

[GoogleCodeExporter]

People WILL read it.

Original comment by hookonso...@gmail.com on 8 Sep 2010 at 2:14

[GoogleCodeExporter]

with no readme, it's guaranteed they'll come here

Original comment by neckil...@gmail.com on 8 Sep 2010 at 6:07

[GoogleCodeExporter]

Many, many newbies here without readme. Just give them chm/html/txt/doc/etc. 
file with basic info (e.g. how to change control keys, how to patch region, how 
to launch a game image etc.) They'll not be here. Mostly, issues list contains 
some problems specific for some games and feature requests. No questions like 
"what is bios and where can i download it?" here.

Original comment by proletar...@gmail.com on 3 Oct 2010 at 10:25