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

Rewrite readme #10431

Merged
merged 1 commit into from Aug 10, 2022
Merged

Rewrite readme #10431

merged 1 commit into from Aug 10, 2022

Conversation

Zopolis4
Copy link
Contributor

@Zopolis4 Zopolis4 commented Feb 3, 2022

The old readme had lots of outdated information, more specifically regarding the files and folders in the Sys and User directories. I have removed this information, as I do not think it particularly belongs in the readme, and perhaps would be better suited to places like the Github wiki (although that itself is significantly outdated), or perhaps a thread in the forum. I have also updated the command line usage section.

@mbc07
Copy link
Contributor

mbc07 commented Feb 3, 2022

The info bits that are getting removed should probably be relocated somewhere else before the merge of this PR...

@Zopolis4
Copy link
Contributor Author

Zopolis4 commented Feb 3, 2022

The info bits that are getting removed should probably be relocated somewhere else before the merge of this PR...

done

@Rukario
Copy link
Contributor

Rukario commented Feb 8, 2022

I feel that the command line information could be handed off to Wiki as well. The readme didn't need a lot of other information. But they also need better visibility than being buried deep into the Wiki.

@Zopolis4
Copy link
Contributor Author

Zopolis4 commented Feb 8, 2022

Then the readme only has build instructions, although in regards to your other point maybe I should edit where the information used to be to have a link to the wiki where the information is.

@Rukario
Copy link
Contributor

Rukario commented Feb 11, 2022

Readme being full of build instruction sounds GitHuby! I'd also put the new link to GitHub Wiki for development related stuff next to where FAQ is in the readme, it's high up there that can provide better visibility. Also the uninistall stuff could be updated too, it's referring to something "below" where you've removed. I think uninstall instruction for each system could be revised to be distributed under "Building" section of each system and then delete the Uninstall section but maybe that's just me.

@Zopolis4 Zopolis4 force-pushed the readmemakover branch 4 times, most recently from a077bab to 683c682 Compare April 8, 2022 11:31
@Zopolis4
Copy link
Contributor Author

I've added the link to the github wiki.

@phire phire merged commit 1dbe2a4 into dolphin-emu:master Aug 10, 2022
10 checks passed
@Zopolis4 Zopolis4 deleted the readmemakover branch August 10, 2022 03:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
4 participants