Skip to content

docs: README for first-time visitors - #68

Merged
Rovey merged 1 commit into
mainfrom
docs/readme-049
Nov 4, 2026
Merged

docs: README for first-time visitors#68
Rovey merged 1 commit into
mainfrom
docs/readme-049

Conversation

@Rovey

@Rovey Rovey commented Nov 4, 2026

Copy link
Copy Markdown
Owner

Summary

A README rewrite for people who arrive from a search and have not installed anything yet.

  • First: what it does, a risk statement, Quick start, "Does it support my card?", how to undo it, and where to report a problem.
  • Lower down, folded: run logs, the search details, and words like offset and soak.
  • Numbers: the All in one figures are now those of the run on the result screenshot (+1.6 % score, 196 → 180 W, fans 73 → 62 %). The run with 5309 it/s at stock is dropped: it is not known whether another program was on the card then. docs/images/hero.svg carries the same numbers.
  • Support: cards other than the RTX 4070, RTX 5070 and RTX 3080 Ti, and laptops, are stated as not tested, with a link to report a result.
  • Corrected: the undervolt FAQ that contradicted All in one, and the row about several GPUs.

Meant to go out with 0.4.9; independent of PR #67.

Test plan

  • Every linked file and image exists; every in-page anchor resolves
  • Read the rendered README on the branch page

🤖 Generated with Claude Code

@Rovey @claude
docs: README for first-time visitors
1c76fc2 
Quick start, card support, undo steps and where to report a problem
come first; run logs and engineering detail move into <details> blocks.
The All in one numbers are those of the run on the result screenshot
(5728 to 5820 it/s, 196 to 180 W): whether the run that measured 5309 at
stock had another program on the card is not known. Laptops and cards
older than the three tested ones are stated as not tested.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Rovey
Rovey merged commit 9d4ca22 into main Nov 4, 2026
2 checks passed
@Rovey
Rovey deleted the docs/readme-049 branch November 4, 2026 22:54
@Rovey Rovey mentioned this pull request Nov 4, 2026
Open
21 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Rovey