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

Modernize README #2699

Merged
merged 12 commits into from Jul 2, 2019
Merged

Modernize README #2699

merged 12 commits into from Jul 2, 2019

Conversation

vadi2
Copy link
Member

@vadi2 vadi2 commented Jul 1, 2019

Brief overview of PR changes/additions

Motivation for adding to Mudlet

Other info (issues closed, discussion etc)

@add-deployment-links
Copy link

add-deployment-links bot commented Jul 1, 2019

Hey there! Thanks for helping Mudlet improve. 🌟

Test versions

You can directly test the changes here:

No need to install anything - just unzip and run.
Let us know if it works well, and if it doesn't, please give details.

@vadi2 vadi2 marked this pull request as ready for review July 2, 2019 05:14
@Kebap
Copy link
Contributor

Kebap commented Jul 2, 2019

Should this also update https://www.mudlet.org/about/ ?

README.md Outdated Show resolved Hide resolved
@vadi2
Copy link
Member Author

vadi2 commented Jul 2, 2019

Just looking to focus on the README for now, but if someone wants to tackle /about that'd be great too

@Kebap
Copy link
Contributor

Kebap commented Jul 2, 2019

I don't get the "You may also like" section at all. Was looking at an old commit there.

Also, maybe link to wiki as well? Not only forums.

@vadi2
Copy link
Member Author

vadi2 commented Jul 2, 2019

That section is now gone, that was a copy/paste error. I'll add a link to the manual.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@vadi2
Copy link
Member Author

vadi2 commented Jul 2, 2019

Feedback applied.

Copy link
Member

@keneanung keneanung 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 to me

@Kebap
Copy link
Contributor

Kebap commented Jul 2, 2019

There are quite a few pictures in the slideshow here, which are not shown on mudlet.org currently - Is that intended?

I would rephrase the "Explain?" into "Please explain in more detail?"

In the "How to Use" section - would you pick a profile name, before entering the connection details?
Also put the brackets in a new line (without increasing count there)

You have appended the three OS in the same line, but also added a new line. In effect you still have a long linear list of items and only the last item has only a single sub-item on a new level. This still looks unsteady. Either move it up a level (preferred), or put the list of OS back down a level. I think it merits a sub list, as these are actually multiple features: 1) Mudlet does run on different OS fine and 2) Scripts created on one OS can be used unchanged on another OS

In the key feature "Open-source and Free" why do you capitalise free? Also there is some ambiguity in the word "free" which can refer to cost or liberty or both. Maybe best to reorder this bullet point to Free and open-source

In the last very short paragraph "Licence" maybe link to GPL2+ too?

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@vadi2
Copy link
Member Author

vadi2 commented Jul 2, 2019

There are quite a few pictures in the slideshow here, which are not shown on mudlet.org currently - Is that intended?

They are on mudlet.org/media

I would rephrase the "Explain?" into "Please explain in more detail?"

This kills any excitement one would have about it...

In the key feature "Open-source and Free" why do you capitalise free? Also there is some ambiguity in the word "free" which can refer to cost or liberty or both.

That's why it's capitalised, because it is both.

In effect you still have a long linear list of items and only the last item has only a single sub-item on a new level.

It looks fine to me, this looks like a personal preference that we can go back and forth on forever. I've taken out the sub-item.

README.md Show resolved Hide resolved
@Kebap
Copy link
Contributor

Kebap commented Jul 2, 2019

And it's live: https://www.mudlet.org/about/

@vadi2
Copy link
Member Author

vadi2 commented Jul 2, 2019

Nice, thanks 😁

@vadi2 vadi2 merged commit cbef340 into development Jul 2, 2019
@vadi2 vadi2 deleted the modernize-readme branch July 2, 2019 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants