Skip to content

Make a clean README.md#24

Open
cleveHEX wants to merge 2 commits into
masterfrom
CornyjK-clean-readme
Open

Make a clean README.md#24
cleveHEX wants to merge 2 commits into
masterfrom
CornyjK-clean-readme

Conversation

@cleveHEX

Copy link
Copy Markdown
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
Copy Markdown
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

cleveHEX commented Apr 23, 2019

Copy link
Copy Markdown
Contributor Author

README files are not meant to cover whole docs.

@JarekParal

JarekParal commented Apr 23, 2019

Copy link
Copy Markdown
Member

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
Copy Markdown
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
Copy Markdown
Member

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

image

@cednik

cednik commented Apr 24, 2019

Copy link
Copy Markdown

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