Skip to content

Conversation

@melroy89
Copy link
Member

@melroy89 melroy89 commented Feb 3, 2025

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:

image

After:

image

@melroy89 melroy89 added the documentation Improvements or additions to documentation label Feb 3, 2025
@melroy89 melroy89 requested a review from BentiGorlich February 3, 2025 19:50
@melroy89 melroy89 enabled auto-merge (squash) February 3, 2025 19:52
@jwr1
Copy link
Member

jwr1 commented Feb 3, 2025

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.

@melroy89
Copy link
Member Author

melroy89 commented Feb 3, 2025

Agreed. For now I focus on the README on github.

@BentiGorlich
Copy link
Member

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 hope that we will have a good showcase page eventually on joinmbin.org but that is a lot of work so we'll see when we'll get it done :D

@BentiGorlich
Copy link
Member

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

@melroy89
Copy link
Member Author

melroy89 commented Feb 3, 2025

I think the main thing we need to do is actually introduce the project and list the features it has.

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:

I will do incremental improvements. This is the first PR of that journey.

@jwr1 is a native English speaker I believe.

@jwr1
Copy link
Member

jwr1 commented Feb 4, 2025

@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?

@melroy89
Copy link
Member Author

melroy89 commented Feb 4, 2025

@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.

@melroy89 melroy89 requested a review from jwr1 February 4, 2025 01:23
Copy link
Member

@jwr1 jwr1 left a 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.

@melroy89 melroy89 changed the title Improve README Improve README (part 1 / x) Feb 4, 2025
@melroy89 melroy89 requested a review from jwr1 February 4, 2025 12:14
@melroy89
Copy link
Member Author

melroy89 commented Feb 4, 2025

Fixed.

Copy link
Member

@jwr1 jwr1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍.

@melroy89 melroy89 merged commit a3e6fc0 into main Feb 4, 2025
7 checks passed
@melroy89 melroy89 deleted the improve-readme branch February 4, 2025 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants