Project

General

Profile

Actions
Copy link

Emulator Issues #6784

closed

New Readme.txt

Added by NeoBrainX over 10 years ago.

Status:
Fixed
Priority:
Normal
Assignee:
NeoBrainX
% 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
Copy link

Also available in: Atom PDF