Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme Fixes and Improvements #1749

Merged
merged 1 commit into from Jan 23, 2015
Merged

Conversation

Buddybenj
Copy link
Contributor

Identical to PR #1655, but with the commits squashed into one.

These are mostly some edits to clean up inconsistencies in the Readme.

Rationale for the edits:

Switched places of Wii and Triforce in lists. Triforce emulation is pretty obviously not treated with the same importance as GameCube and Wii emulation is and so I feel it makes sense to have it listed last rather than second.

Made the spacing between slashes consistent. In some locations slashes had spaces and in others they didn't. I chose to add spaces throughout as it makes it a bit easier to read.

Gave Linux and OS X separate lines in the system requirements. If Windows gets its own line it makes sense for Linux and OS X to also have their own lines. This also clears up a potential ambiguity in what 10.9 is referring to.

Unified title capitalization. Some titles used capitals for the whole title and others only used capitals for the first word. I decided to capitalize all the titles.

Removed Vista or higher as higher as a requirement for using D3D. As Vista or higher is already a requirement for running Dolphin on Windows this is completely redundant. Also cleaned up a bit of a typo here.

These are mostly some edits to clean up inconsistencies in the Readme.

Rationale for the edits:

Switched places of Wii and Triforce in lists. Triforce emulation is pretty obviously not treated with the same importance as GameCube and Wii emulation is and so I feel it makes sense to have it listed last rather than second.

Made the spacing between slashes consistent. In some locations slashes had spaces and in others they didn't. I chose to add spaces throughout as it makes it a bit easier to read.

Gave Linux and OS X separate lines in the system requirements. If Windows gets its own line it makes sense for Linux and OS X to also have their own lines. This also clears up a potential ambiguity in what 10.9 is referring to.

Unified title capitalization. Some titles used capitals for the whole title and others only used capitals for the first word. I decided to capitalize all the titles.

Removed Vista or higher as higher as a requirement for using D3D. As Vista or higher is already a requirement for running Dolphin on Windows this is completely redundant. Also cleaned up a bit of a typo here.
@@ -76,9 +77,9 @@ LLE (Low Level Emulation). HLE is fast but often less accurate while LLE is
slow but close to perfect. Note that LLE has two submodes (Interpreter and
Recompiler), which cannot be selected from the command line.

Available video backends are "D3D" (only available on Windows Vista or higher),
Available video backends are "D3D" (only available on Windows) and

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

@ghost ghost mentioned this pull request Dec 26, 2014
@Buddybenj
Copy link
Contributor Author

Yes, this should be ready for merge unless someone can find any other problems in the readme.

@Buddybenj
Copy link
Contributor Author

However, to conform more to the style once this is merged, the GitHub repository description should be changed from "Dolphin is a GameCube/Wii emulator, allowing you to play games for these two platforms on PC, with improvements." to "Dolphin is a GameCube / Wii emulator, allowing you to play games for these two platforms on PC with improvements." (add spaces between slash and remove extraneous comma).

@Tilka
Copy link
Member

Tilka commented Jan 15, 2015

@dolphin-emu-bot rebuild

Sonicadvance1 added a commit that referenced this pull request Jan 23, 2015
Readme Fixes and Improvements
@Sonicadvance1 Sonicadvance1 merged commit 618dfe9 into dolphin-emu:master Jan 23, 2015
@Buddybenj Buddybenj deleted the readme branch January 23, 2015 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
5 participants