4

I don't understand people that say
'I like the current format of the readme more'
...
What formatting??

This was the PR:
https://github.com/SakuraNoKisetsu/...

Comments
  • 4
    I have to agree with them.

    It's not a big readme and it's readable. Probably, I would also consider this change as an unnecessary overkill.
  • 2
    I'm not a big fan of the huge margins and center justification of the new readme
  • 2
    @Lasoloz Justifying not doing anything just because the README isn't multiple pages long seems nonsensical to me.

    In the first place a README shouldn't be very long to begin with.

    Also considering the work has already been done, there is no harm in just accepting it.

    Just for the sake of the source it would be beneficial to consider it.

    https://github.com/NuclearPowered/...

    https://github.com/SakuraNoKisetsu/...
  • 4
    @ElectroArchiver

    I'm still not convinced. Very short sections with lots of bold text does not really help me to understand the repository more. Just like books usually don't have 2 liner chapters.

    Also, markdown is supposed to be simple and readable by humans. Using a lot of HTML does the opposite of that.

    PS: I'm not saying that the original readme was perfect or it wouldn't need some improvement. I just agree with the maintainers by saying that this is too much in my opinion.
  • 2
    @Lasoloz

    > I'm still not convinced. Very short sections with lots of bold text does not really help me to understand the repository more. Just like books usually don't have 2 liner chapters.

    Are you talking about the feature *List*, it's a list, pointing out content points, not explaining them.

    You call that a lot of HTML?

    break tags & centered blocks..

    Considering Markdown is a superset of HTML and those are feature purposly not disabled by GitHub, obviously I'm gonna make use of them.

    Also you say it's meant to be simple but if you compared the 'simple' original markdown I'd argue that it sure isn't.

    Btw, if that is 'too much' for you, you better not look at the following ;3

    https://github.com/Fresh791/...

    *Dynamic badges~*
  • 1
    @ElectroArchiver no, sorry I wasn't clear, I was referring to the 2nd level headings instead of the lists. Maybe this one was a bit of an exaggeration.

    Regarding the HTML stuff: while Markdown is a superset of HTML, I still wouldn't generally use it in places where some people might open it with a simple text editor incapable of rendering it (e.g. sometimes, when it seems more convinient, I do open repository files with basic text editors, or with nano/micro in the console)

    Anyways, I think we fundamentally disagree with the way repository readmes should look like, but your intentions are nice. I wouldn't have the time and the mood to do stuff like this :)
  • 1
    @Lasoloz

    > Regarding the HTML stuff: while Markdown is a superset of HTML, I still wouldn't generally use it in places where some people might open it with a simple text editor incapable of rendering it (e.g. sometimes, when it seems more convinient, I do open repository files with basic text editors, or with nano/micro in the console)

    Well thankfully these days, most systems have pdf + markdown + .. viewers that can work with a much broader sort of markdown than the limited GitHub flavor.

    > Anyways, I think we fundamentally disagree with the way repository readmes should look like, but your intentions are nice.

    Well since READMEs are front pages of projects, they should look as such I'd say~

    > I wouldn't have the time and the mood to do stuff like this :)

    Well that's what I mainly do these days - documentation - and it's not exactly fun, though I have even less fun when I have to use bad docs, so I started formatting stuff in general
  • 3
    The version on the image you posted on devrant is much easier to read. It gets my vote.
  • 1
    I agree with them
Add Comment