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
Modernize README #2699
Conversation
Hey there! Thanks for helping Mudlet improve. 🌟 Test versionsYou can directly test the changes here:
No need to install anything - just unzip and run. |
Should this also update https://www.mudlet.org/about/ ? |
Just looking to focus on the README for now, but if someone wants to tackle |
Also, maybe link to wiki as well? Not only forums. |
That section is now gone, that was a copy/paste error. I'll add a link to the manual. |
Feedback applied. |
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 to me
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? 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? |
They are on mudlet.org/media
This kills any excitement one would have about it...
That's why it's capitalised, because it is both.
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. |
And it's live: https://www.mudlet.org/about/ |
Nice, thanks 😁 |
Brief overview of PR changes/additions
Motivation for adding to Mudlet
Other info (issues closed, discussion etc)