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

Update README before making the repository public #21

Merged
merged 3 commits into from
Mar 1, 2021
Merged

Conversation

alranel
Copy link
Member

@alranel alranel commented Feb 28, 2021

This PR cleans the README with relevant information for users and contributors.

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@rsora rsora left a comment

Choose a reason for hiding this comment

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

It seems that .svg files are not allowed on the README file
https://github.com/arduino/vscode-arduino-tools/pull/21/checks#step:5:59

ERROR  SVGs are restricted in README.md; please use other file image formats, such as PNG: https://content.arduino.cc/website/Arduino_logo_teal.svg

@alranel
Copy link
Member Author

alranel commented Mar 1, 2021

@rsora actually they are supported now: https://github.com/alranel/svg-readme-test
(They used to be blocked in the past)

@rsora
Copy link
Contributor

rsora commented Mar 1, 2021

@alranel the problem is that yarn doesn't like the SVG, can we replace it with a .png?

@rsora
Copy link
Contributor

rsora commented Mar 1, 2021

Actually, it seems to be an error generated by the VSCode Extension packager microsoft/vscode-vsce#183, .svg are not allowed in the VSCode extensions marketplace.

Copy link
Contributor

@rsora rsora left a comment

Choose a reason for hiding this comment

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

Removed the .svg image tag, the rest is good

@rsora rsora merged commit 537e98e into main Mar 1, 2021
@kittaakos kittaakos deleted the readme-release branch March 3, 2021 12:48
@per1234 per1234 added topic: documentation Related to documentation for the project type: enhancement Proposed improvement labels Feb 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants