-
Notifications
You must be signed in to change notification settings - Fork 30
Improve README (part 1 / x) #1416
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
Conversation
|
joinmbin.org's home page should probably be updated as well, considering it's basically a copy of the README, at the moment. Eventually though, it would be nice if the home page were its own thing, and redesigned to be more user friendly. |
|
Agreed. For now I focus on the README on github. |
|
It is a good start. I think the main thing we need to do is actually introduce the project and list the features it has. "A fork of kbin" just doesn't mean anything to anyone (anymore), since kbin is basically dead... (we have to keep it in the Readme, but maybe a little further down) |
|
I think we have to get a native speaker to look through it and correct the weird variations of English we both are speaking :D |
This is what I want to do after this PR basically. So I want to get rid of the current list. And just focus on what Mbin is and its features. Like I said:
@jwr1 is a native English speaker I believe. |
That is correct. Is there anything specific I should look for, or just review it and check for grammar? |
Well, it does answer the question of bentigorlich. Now, I would like to follow up later with additional PRs which most likely will contain more English text changes. I truthly believe this pr is a small fix. So feel free to review the changes of course. But I will follow up with bigger PRs where I will remove and add more text to the Readme file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pretty much only needed a few punctuation changes. One of the sentences seemed like it needed to be reworded though.
Co-authored-by: jwr1 <[email protected]>
Co-authored-by: jwr1 <[email protected]>
Co-authored-by: jwr1 <[email protected]>
|
Fixed. |
jwr1
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good 👍.
I want to improve the README quite a bit. It hasn't be touched for months.
I will do incremental improvements. This is the first PR of that journey.
Before:
After: