Project

General

Profile

Actions

Emulator Issues #6784

closed

New Readme.txt

Added by NeoBrainX over 10 years ago.

Status:
Fixed
Priority:
Normal
Assignee:
% Done:

0%

Operating system:
N/A
Issue type:
Other
Milestone:
Regression:
No
Relates to usability:
No
Relates to performance:
No
Easy:
No
Relates to maintainability:
No
Regression start:
Fixed in:

Description

I rewrote our Readme.txt to make it more useful for anything.

Logic behind my changes:

  • do not try to target any users who don't build Dolphin by themselves
  • don't assume the reader is dumb and include actual information
  • try to explain more stuff which was previously undocumented (LLE subengine not being configurable, custom textures location, ...)
  • explain the build system in more detail. I figured that people (myself included) often download software and only read the readme file.
  • removed some outdated things

System requirements have been updated. I removed the reference to F|RES and ector because Dolphin doesn't really have a "project leader" and the tribute felt kinda out of place.

TODOs (reasons for this pull request):

  • review spelling
  • OSX installation/uninstallation
  • discussion on these changes, if required
  • proposals for things that need explaining in the Readme (I'm sure custom textures aren't the only thing that should've been added)

Attached are the patch and the new Readme.txt.

Actions #1

Updated by kostamarino over 10 years ago

Well i think that the guides section of the site is also very helpful and it deserves a referral along with the faq. Also regarding the requirements, they are pretty vague the way they are worded and open to interpretations, needs to be a bit more specific. There is a huge difference between a dual core bulldozer and a dual core haswell at 3.0 ghz in dolphin. For example something like that a latest intel dual core chip clocked at 3.0 ghz is suggested, with amd cpus needing a much higher clocking of at least 4,0ghz+.

Actions #2

Updated by pauldacheez over 10 years ago

So my work isn't lost to the ether again, here's that Readme.txt with OS X-related edits. http://pastebin.com/EPWuHV5H

Actions #3

Updated by NeoBrainX over 10 years ago

New revision:

  • merged with pauldacheez's suggestions
  • rephrased the CPU requirements a bit; going into detail here is just ridiculously blowing everything up, so I randomly chose "2008" as a CPU release year to look at (based on the release date of Intel's Core-i-series)

If there's no further concerns about this, I'll merge it sometime in the next few days.

Actions #5

Updated by NeoBrainX over 10 years ago

  • Status changed from New to Fixed
Actions

Also available in: Atom PDF