Skip to content

docs: polished README + CMake build + MIT license - #1

Merged
ldocs17 merged 2 commits into
mainfrom
docs/readme-cmake-license
Jul 23, 2026
Merged

docs: polished README + CMake build + MIT license#1
ldocs17 merged 2 commits into
mainfrom
docs/readme-cmake-license

Conversation

@ldocs17

@ldocs17 ldocs17 commented Jul 23, 2026

Copy link
Copy Markdown
Owner

What

Documentation overhaul for the CSV→Parquet engine.

  • README rewritten: one-line pitch, Mermaid architecture diagram, accurate "how it works" (zero-copy mmap, lock-free chunk parallelism, predictive Arrow allocation), platform build instructions, benchmark methodology, project structure, and a roadmap.
  • CMakeLists.txt added so the README's cmake build steps actually work (finds Arrow + Parquet, links pthreads, handles new/old Arrow target names).
  • LICENSE (MIT) added — swap if you prefer a different license.

Notes / honest caveats

  • The README documents the current behavior truthfully: input path, output path, and thread count are constants at the top of CSVtoParquet.cpp. CLI args are listed as the first roadmap item, not claimed as existing.
  • No CI workflow included (kept this docs-only), so the build-status badge was intentionally omitted to avoid a broken badge. CI is on the roadmap.
  • Benchmark numbers are carried over from the existing README/commit history — re-verify before quoting them elsewhere.

🤖 Generated with Claude Code

ldocs17 and others added 2 commits July 22, 2026 21:09
- README: add architecture diagram, accurate build/usage steps, benchmark
  methodology, project structure, and roadmap
- CMakeLists.txt: reproducible build wiring Arrow + Parquet + pthreads
- LICENSE: MIT

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- .github/workflows/ci.yml: builds on push/PR using conda-forge libarrow-all
  (Arrow + Parquet) and the project CMakeLists
- README: re-add CI status badge, tick CI in roadmap

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@ldocs17

ldocs17 commented Jul 23, 2026

Copy link
Copy Markdown
Owner Author

Added a GitHub Actions build workflow (.github/workflows/ci.yml) to this PR — it installs Arrow + Parquet via conda-forge libarrow-all and builds with the new CMakeLists on every push/PR. First run passed in 43s ✅, so the build badge (now restored in the README) is green. Only non-fatal deprecation warnings remain (Node 20 / auto-activate-base).

@ldocs17
ldocs17 merged commit 2a0fc32 into main Jul 23, 2026
1 check passed
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