search

psemiletov / tea-qt

TEA text editor
https://tea.ourproject.org
GNU General Public License v3.0
89 stars 13 forks source link

Improve README.md #56

Closed goyalyashpal closed 2 years ago

goyalyashpal commented 2 years ago

The result is that the overall document looks much more organised with proper formatting for the corresponding context. The overall document structure with headings is also improved as can be seen in the following screenshot:

image

goyalyashpal commented 2 years ago

ping @psemiletov

psemiletov commented 2 years ago

Thanks a lot!

goyalyashpal commented 2 years ago

waow: 😆🤣

psemiletov commented 2 years ago

Yes, because I remembered that readme.md must looks normal as the plain text, so "bash" tags aren't good :(

goyalyashpal commented 2 years ago

there are many things i like to say:

  1. first and foremost, i am not pushing for merging my changes or anything like that, i hope it doesn't feel like that either. i am just discussing here. so, following are my thoughts:

because I remembered that

like if some proposed changes are not good then:

  1. you could have commented wit the concerns that this and this thing is not good and will not work
  2. the pr author (in this case me) will most likely respond - either with some new proposal, or their acceptance that the pr can be closed

must looks normal as the plain text, so "bash" tags aren't good :(

for this, i made other changes which worked on normal plain text too - so, i guess that while attempting to address the above concern, you actually reverted those changes too

again, i am not pushing for those, i just feel that this could have been much better handled with discussion.

anyways, it's totally fine. awesome what works for you. take care.

psemiletov commented 2 years ago

README.md in TEA plays two roles - github's README.md, and "standard" README from the common tarball. When you made the commit, I thinked that it's fine, because it looked good. And I've merged the commit. But then I remembered the dual neture of TEA's README.md...

goyalyashpal commented 2 years ago

ahw ohkay ohkay. got it.

can u share the rendered output of "standard" README from the common tarball ??