beman.exemplar: change library status to under development (exemplar is a template library)#89
Conversation
4d2db3c to
b168053
Compare
|
@wusatosi , what should I do here? |
Hum, weird, inline HTML check should have been disabled. I will look into this. |
OK. Then I will proceed with the PR, as this behaviour is not from changed lines. |
There was a problem hiding this comment.
OK. Then I will proceed with the PR, as this behaviour is not from changed lines.
No. lint break is caused by changed lines.
Avoid fighting with markdownlint with ignore statements, ignore should be the last resort.
Put faith into the linting infrastructure, let's not have our code littered with lint-ignores.
I agree with any solution which can work right now. So what should I do if the CI complains the line is too long? And I actually want to insert a text with hyperlink? (The text is short, the hyperlink is long). Currently, the infrastructure seems to not consider this case. If this is true, it should be solved in other issue/PR. |
0a443e5 to
508df8c
Compare
It looks like markdown lint ignores length overflow due to url via |
@wusatosi , would you agree with current PR state? Check rendered version. |
|
@wusatosi , can you take a look? |
Hey sorry I missed this PR.
Edit: agh, I see, it takes the entire page. |
|
Also, I think you should reference the direct asset link. Instead of the github link . The link you provided does not get displayed correct everywhere. Or you should add |
|
Why not, instead of putting this cute logo on the front, we just put a badge here. e.g. # beman.exemplar: A Beman Library Exemplar



`beman.exemplar` is a minimal C++ library conforming to [The Beman Standard](https://github.com/bemanproject/beman/blob/main/docs/BEMAN_STANDARD.md).
This can be used as a template for those intending to write Beman libraries.
It may also find use as a minimal and modern C++ project structure.This is a lot cleaner, there's no readability issue and weird formatting, its dense and easy to glance over. See: my alternative with badge We could still put the cute logo in a later section to allow branding and a more detailed write out. |
|
If we still want the logo, would this be a better altnerative? See this as an example Note: We could still add Status below the implementation back. As this would violate [README.LIBRARY_STATUS] |
wusatosi
left a comment
There was a problem hiding this comment.
Concern regarding the readability.
We can proceed without the icon for now and move the discussion to discourse.
508df8c to
70c3086
Compare
@wusatosi , check latest status of this PR. I proposed to put this 4 SVGs in the beman docs: https://github.com/bemanproject/beman/pull/84/files. |
70c3086 to
e801293
Compare
3c5f23a to
2963198
Compare
2963198 to
91c78b3
Compare
This is fantastic, thank you for all these work. |











Issues: bemanproject/beman#77
Expected README.md: