Skip to content

Make a clean README.md #24

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Make a clean README.md #24

wants to merge 2 commits into from

Conversation

cleveHEX
Copy link
Contributor

Current situation is not ideal, README.md is too bloated and the platform is hard to maintain.

@cleveHEX cleveHEX self-assigned this Apr 22, 2019
@JarekParal
Copy link
Member

I'm not sure that the README.md was too bloated.

But now I have a problem with the clarity of the Pinout wiki. The previous style was better for me in README.md.

@cleveHEX
Copy link
Contributor Author

cleveHEX commented Apr 23, 2019

README files are not meant to cover whole docs.

@JarekParal
Copy link
Member

JarekParal commented Apr 23, 2019

Yes, but the Pinout wiki isn't simple enough for beginners.
The previous style in README.md was, in my opinion, better for beginners.

@cleveHEX
Copy link
Contributor Author

I do not see how the README.md version is simpler, the one in wiki looks better. Also it is better to not have the same stuff on zillion places, because it is hard to maintain.

@JarekParal
Copy link
Member

I don't know but the left side is more readable and clear in my opinion (especially for beginners):

image

@cednik
Copy link

cednik commented Apr 24, 2019

I agree with @JarekParal - left side is better (especially for begginers).
To wiki version: I think, that the left-most column Pin is redundant and maybe confusing. Dn is Arduino only pin marking and therefore it is in Arduino column. On ESP32 this is completly irrelevant.

@cleveHEX cleveHEX marked this pull request as ready for review May 9, 2019 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants