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

README update #1991

Merged
merged 11 commits into from
Nov 9, 2024
Merged

README update #1991

merged 11 commits into from
Nov 9, 2024

Conversation

ia
Copy link
Collaborator

@ia ia commented Nov 9, 2024

  • Please check if the PR fulfills these requirements
  • The changes have been tested locally
  • There are no breaking changes
  • What kind of change does this PR introduce?
    README.md update.

  • What is the current behavior?
    There is no direct link to supported hardware table.

  • What is the new behavior (if this is a feature change)?
    Add Supported Hardware markdown-powered subtitle, so HTML anchor could be used to provide the direct link to the related information like this!

  • Other information:

Hello. Long time no see. As you may noticed, in the discussions or during online conversations new people are keep asking from time to time the same old question: "what hardware are supported?". With this update, table will be available via github interface and on the read-the-docs instance of the documentation through the direct link (instead of giving people instructions like "open this link first and then scroll down to the table). So I think this can be pretty useful in the future to share with new users or just for those who want to check the current status of supported hardware in one direct click.

Plus, a bit of actualization here and there, since we're not in Kansas anymore dealing with irons only anymore. ;)

However, since I decided to edit README anyway, I took some liberty to polish & beautify it a bit and make some sections more structural (like buttons control). If I took too much liberty then just let me know, because as always I'm very curious about the feedback.

Oh, and I know that "licence" is grammatically fully correct but I just thought to use more commonly wide "license". And of course let me know if I did make any mistypes/mistakes myself.

P.S. I'm sorry for the absence but I tried to follow up & check up with the project. Just had very busy a couple of months. But I always sincerely happy to be around & being useful in any way for this project. 🙏

Sorry, something went wrong.

ia added 11 commits November 9, 2024 21:20

Verified

This commit was signed with the committer’s verified signature.
jorgebucaran Jorge Bucaran
@ia ia added the Documentation Markdown, ReadTheDocs & GH Pages. label Nov 9, 2024
@Ralim
Copy link
Owner

Ralim commented Nov 9, 2024

Thank you 😍

I've been busy this year as well so it hasn't moved as fast anyway

@Ralim Ralim merged commit 79c12a5 into Ralim:dev Nov 9, 2024
18 checks passed
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@ia
Copy link
Collaborator Author

ia commented Nov 14, 2024

Dear @yo3fxy! Thank you for pointing out these mistypes, much appreciated. The more I edited text the less I saw any particular letters. :|

Good job. I've made a patch for this patch already taking into consideration your feedback. But could you, please, double check it again here (#1996) after me as well to make sure we didn't miss anything else? Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Markdown, ReadTheDocs & GH Pages.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants