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

A better and user friendly read me! #18062

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

coderzawad
Copy link

I've revamped the README to make it more engaging and user-friendly. Here are the key improvements:

  1. Added emojis to make the content more visually appealing and easier to scan.
  2. Restructured the content to prioritize the most important information.
  3. Simplified the installation instructions and grouped them logically.
  4. Condensed the developer section while maintaining crucial information.
  5. Added a quick feature list to highlight Windows Terminal's capabilities.
  6. Improved the overall flow and readability of the document.
  7. Included a catchy tagline and closing call-to-action to encourage engagement.

Best Regards,
Thank you -
[email protected]

I've revamped the README to make it more engaging and user-friendly.
Copy link
Member

@lhecker lhecker left a comment

Choose a reason for hiding this comment

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

I'm 100% in favor of simplifying our readme like you did, but I'm personally averse to making it more "playful". I'd prefer if it was factual and direct. VS Code has a nice readme: https://github.com/microsoft/vscode
(Also, let's please not use LLMs for generating our main readme.)

Copy link
Member

@zadjii-msft zadjii-msft left a comment

Choose a reason for hiding this comment

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

I agree with lhecker's comments. There's also a decent amount of content that was removed from the "Developer Guidance" section, that was removed in favor of going to the contributor's guide. I don't disagree with that, but let's make sure to actually move that content to it's new home 😉

@microsoft-github-policy-service microsoft-github-policy-service bot added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Oct 28, 2024
@coderzawad
Copy link
Author

@zadjii-msft wrote :-

I agree with lhecker's comments. There's also a decent amount of content that was removed from the "Developer Guidance" section, that was removed in favor of going to the contributor's guide. I don't disagree with that, but let's make sure to actually move that content to it's new home 😉

Thank you for your feedback. The requested changes will be made soon!

@microsoft-github-policy-service microsoft-github-policy-service bot added Needs-Attention The core contributors need to come back around and look at this ASAP. and removed Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something labels Oct 30, 2024
@zadjii-msft zadjii-msft added Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something and removed Needs-Attention The core contributors need to come back around and look at this ASAP. labels Oct 30, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the No-Recent-Activity This issue/PR is going stale and may be auto-closed without further activity. label Nov 6, 2024
Copy link
Contributor

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 7 days. It will be closed if no further activity occurs within 7 days of this comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something No-Recent-Activity This issue/PR is going stale and may be auto-closed without further activity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants