readme file

[MungoG]

Summary by CodeRabbit

• Documentation
  • Enhanced README with comprehensive project overview describing the coroutine-first I/O library for C++20.
  • Added status badges and reference links for branches, documentation, and CI/CD.
  • Included license information and references.

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

[coderabbitai]

📝 Walkthrough

Walkthrough

A README.adoc file is added containing project overview for Boost.Corosio, including a status badges table, library description emphasizing C++20 coroutines and asynchronous I/O primitives, executor affinity propagation details, and Boost Software License information.

Changes

Cohort / File(s)	Summary
Documentation README.adoc	New file with project overview, status badges, library description, asynchronous I/O operation details with affine awaitable protocol, and license section

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A README now hops into place,
Describing coroutines with grace!
With badges that shine and docs so fine,
Boost.Corosio's story does line up in line.
Executors aligned, the library's divine! ✨

🚥 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, failing to describe the specific nature of the README changes or convey meaningful information about what was added.	Use a more descriptive title such as 'Add comprehensive README with project overview, documentation links, and build badges' to clearly communicate the actual changes.

✅ 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 11:22:51 UTC