Skip to content

Add a README, and move agent guidance into AGENTS.md - #6

Merged
bfierz merged 1 commit into
mainfrom
docs/readme-and-agents-md
Oct 17, 2026
Merged

bfierz merged 1 commit into
mainfrom
docs/readme-and-agents-md

Conversation

@bfierz

@bfierz bfierz commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

Summary

  • README.md (new): what FloatWeaver is, with two short examples (float8 arithmetic and an Eigen cross product), features, supported WEAVER_VECTORIZE backends, building with or without Conan, running the tests, building the docs, and acknowledgements for the SIMD math functions.
    • Origin section: FloatWeaver began as the SIMD module of VCL and is a from-scratch C++17 reimplementation of it as a standalone library.
  • AGENTS.md (new): project guidance for coding agents (background, build and test commands, architecture), written so any agent can use it. References to the vcl source tree are removed.
  • CLAUDE.md (new): only imports AGENTS.md, so Claude Code gets the same guidance.

Notes for review

  • The README doesn't link to the hosted docs yet, because the GitHub Pages URL isn't confirmed. Worth adding once it is.
  • The build commands, backend list and CI coverage were taken from CMakeLists.txt, cmake/config.cmake and .github/workflows/. The code examples come from doc/snippets.

The README covers what FloatWeaver is, supported backends, how to build
and test it, the docs, and where the library came from (the SIMD module
of VCL).

The project guidance for coding agents lives in AGENTS.md so any agent
can use it; CLAUDE.md just imports it.
@bfierz
bfierz merged commit 734b67e into main Oct 17, 2026
28 checks passed
@bfierz
bfierz deleted the docs/readme-and-agents-md branch October 17, 2026 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant