# Making exemplar/README.md more concise

**URL:** <https://discourse.bemanproject.org/t/making-exemplar-readme-md-more-concise/462>\
**Category:** Beman Website and Docs\
**Created:** [July 8, 2025, 12:33am UTC](https://discourse.bemanproject.org/t/making-exemplar-readme-md-more-concise/462 "2025-07-08T00:33:49Z")\
**Posts on this page:** 1\
**Showing post:** 8

<div class="post-metadata">

**Author:** ![Jeff-Garland](https://yyz1.discourse-cdn.com/flex029/user_avatar/discourse.bemanproject.org/jeff-garland/32/23_2.png) [@Jeff-Garland](https://discourse.bemanproject.org/u/Jeff-Garland)\
**Post date:** [July 18, 2025, 6:17pm UTC](https://discourse.bemanproject.org/t/making-exemplar-readme-md-more-concise/462/8 "2025-07-18T18:17:17Z")

</div>

> [@dsankel](#):
>
> I think it is useful to consider what we want the user experience to be like under various scenarios. Here are a few examples:
> 
> …details suppressed…
> 
> I think for all of these, answering the questions “What is the purpose of this library?” and “What does code using this library look like?” are the first ones to answer.

This seems foundational so that should always be first. In a future world where libraries have dedicated docs I think a link to that should also be right there because that’s often the next stop for anyone trying to use things. btw, there’s already a PR in website repo that demos how those docs can have live godbolt content – we likely can reuse that on readme as well. And _inconsistently_ we have godbolt badge links: see [scope library](https://github.com/bemanproject/scope) for an example.

> [@dsankel](#):
>
> The question that follows for at least a subset of scenarios will be “_Can_ I use this library?”. In other words, does it require some compiler+flags combo that I have access to?

This is where I was suggesting something like this would give an ‘at a glance’ overview

### Usage Requirements (don’t like the title)

| Compiler | flags | Linux | MacOS | Windows |
| --- | --- | --- | --- | --- |
| gcc (13-15) | c++20 | Passing | | |
| gcc(13-15) | c++23 | Passing | | |
| gcc(13-15) | c++26 | Passing | | |
| gcc-reflection | c++26 | Passing | | |
| mac-clang | c++23 | | Passing | |
| msvc | /c++:latest | | | Passing |
| joes-compiler | Unsupported | | | |

– link to the licence.md file here

I think @purpleKarrot showed us something similar at C++Now for table of status.

> [@dsankel](#):
>
> Then, after all that, I think the questions fork. Some people want “How do I incorporate this library into my project?” and others want “How do I make contributions?”.

Yep. Right now we’re following the first 2 elements decently, but things get inconsistent after that. As I probably already mentioned I think the ‘contributing guide’ could be another file linked from the readme that gets into all the details of setting up tests, etc.

---

_[View the full topic](https://discourse.bemanproject.org/t/making-exemplar-readme-md-more-concise/462)._