readme file

[MungoG]

Summary by CodeRabbit

• Documentation

  • Added a comprehensive project overview describing the coroutine-first I/O library for C++20, async primitives, and executor affinity behavior.
  • Included status badges, links for branches/docs/CI, and license information.

• Chores

  • Updated ignore rules to add new entries and refine a path-specific ignore pattern.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds a new README.adoc with project overview, status badges, asynchronous I/O and affine awaitable protocol description, and license section; updates .gitignore to add ignore entries and adjust a CMake presets rule.

Changes

Cohort / File(s)	Summary
Documentation README.adoc	New top-level README added: status badges table, project overview for Boost.Corosio, description of coroutine-first async I/O and executor affinity (affine awaitable protocol), and Boost Software License section.
Repository config /.gitignore	Added ignore patterns /.clangd and /tmpclaude-*-cwd; changed CMakeUserPresets.json ignore to be root-anchored (/CMakeUserPresets.json).

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A README hops in, crisp and bright,
Badges gleam in careful sight.
Coroutines hum, executors sing,
License seals the gentle spring.
Hooray — the docs make the garden tight!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title "readme file" is vague and generic, lacking specificity about what the README adds or its purpose.	Use a more descriptive title that conveys the main change, such as 'Add comprehensive README with project overview and build status' or 'Document Corosio project overview and build badges'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@README.adoc`:
- Line 8: Replace the first-column cell that currently contains the markdown
link string "|https://develop.corosio.cpp.al/[Docs]" with a plain row label
"Docs" so the table's first column is only the label; leave the existing
documentation links in the second and third columns unchanged. Locate the table
row that includes the "[Docs]" link and change that cell content to the literal
text Docs (no link markup) ensuring the other cells in the same <row> remain
intact.
- Line 40: Replace the Markdown-style link in the README.adoc line containing
"(See accompanying file [LICENSE_1_0.txt](LICENSE_1_0.txt) or copy at" with
AsciiDoc link syntax by converting the [text](url) form into the AsciiDoc
link:url[text] form so the license link renders correctly in AsciiDoc.

🧹 Nitpick comments (1)

README.adoc (1)

16-16: Remove extra blank line for consistency.

There's an extra blank line here (two consecutive empty lines) while other rows are separated by a single blank line. This creates formatting inconsistency in the table structure.

♻️ Proposed fix

-
-
+
 |https://drone.io/[Drone]

[cppalliance-bot]

An automated preview of the documentation is available at https://35.corosio.prtest3.cppalliance.org/index.html

If more commits are pushed to the pull request, the docs will rebuild at the same URL.

2026-01-20 13:17:55 UTC