Skip to content

Enhance readme for readability #9106

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

Merged
merged 1 commit into from
Sep 17, 2019
Merged

Conversation

TheKnarf
Copy link
Contributor

  • Adding Arduino logo from website as a part of the Readme

  • Making links easier to read by using link names instead of showing the whole link

@TheKnarf TheKnarf force-pushed the task/readme branch 2 times, most recently from c9191ee to cf202c4 Compare July 29, 2019 20:03
@TheKnarf
Copy link
Contributor Author

The PR Quality Review is complaining about [list-item-indent] Incorrect list-item indent: add 2 spaces, but I have no idea how to fix it. I've tried force pushing a few changes to try and see if I could figure it out, but it doesn't fix it.

Still; I think this is an improvement over how the Readme currently looks.

@facchinm
Copy link
Member

@per1234 what do you think about this?

@per1234
Copy link
Collaborator

per1234 commented Sep 17, 2019

It looks good to me. I'm always partial to bulleted lists.

I would prefer the logo to be a bit smaller, since it pushes the useful information in the readme quite a way down the page, but maybe others like the big and bold logo.

I don't know what the situation is with the Codacy check failure. I have always used a single space to separate the bullet character from the text in Markdown lists and it seems the attempt to fix the failure by adding an extra space in the force push still didn't resolve the failure.

@facchinm
Copy link
Member

I'm going to merge it then; we can make the logo smaller in another commit if needed

@facchinm facchinm merged commit b551bf5 into arduino:master Sep 17, 2019
@cmaglie cmaglie added this to the Release 1.8.11 milestone Jan 22, 2020
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.

4 participants