Skip to content

Rewrite the README as a README - #69

Merged
CanReader merged 1 commit into
masterfrom
docs/readme
Oct 30, 2026
Merged

CanReader merged 1 commit into
masterfrom
docs/readme

Conversation

@CanReader

@CanReader CanReader commented Oct 30, 2026 •

Copy link
Copy Markdown
Owner

What this changes

The README is a README again what it means? Well iit was looking like a docs before but now our project published to cargo and have a official docs so we can make README as a README again MRGA (Make README Great Again): a centered header with the tagline, badges and links, a Highlights list, installation, quick start, the examples table, the architecture diagram under "How it fits together", what is inside, platform support with the CUDA build notes, a short testing section, limitations, contributing and license. 390 lines down to 239.

Why

It had grown into a second manual. The docs.rs crate page now walks through models, training, data, checkpoints, the GPU, generation and debugging, so the README can do its own job and point there.

How it was verified

  • cargo test passes
  • cargo clippy --all-targets -- -D warnings is clean
  • Ran cuda_parity on a GPU
  • Trained an example in --release
  • No GPU here, CUDA side not runtime tested

Docs only. Every relative link resolves, the quick start is the snippet that compiles as a doctest in the crate docs, and cargo package includes the README and assets/architecture.svg. Rendered on GitHub to check the header and the diagram.

Checklist

  • Every new or changed backward rule has a gradcheck case
  • Every new kernel has a cuda_parity case
  • tensor/ops and autograd/ops still mirror each other
  • Public items have /// docs

@CanReader
CanReader merged commit fa7b761 into master Oct 30, 2026
12 checks passed
@CanReader
CanReader deleted the docs/readme branch October 30, 2026 17:12
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