readme-ai

README file generator, powered by AI.

Runssource: GitHubhomepagePythonMITcommit 6f507b5f8779

Python, MIT licensed. The project labels itself: agents, ai, ai agents, ai documentation, anthropic, badge generator, cli and developer tools.

readme-ai runs. An Argusic agent installed it in 1.5 minutes and hit 1 error and fixed every one without help on a clean machine with no GPU, and the whole session was recorded.

ReadmeAI CLI installed via Poetry with tiktoken 0.14.0; CLI reports version 0.6.0.rc1 and `--help` shows all options; offline README generation succeeds producing a 1064-line, 45KB markdown file; 373 of 378 collected tests pass (5 skipped due to conftest/environment conditions), coverage at 79.40%.

What the agent ended up with on a clean machine, in its own words. How this is measured

Measured by Argusic on a fresh machine every time. Every number links to its evidence. Argusic Score 100 of 100 (the mean of this project's run scores).

At a glance

verdict
Runs
Argusic Score
100 / 100
cost of the verifying run
$0.03 (measured)
recorded runs
2
last tested
stars
3,013
forks
295
open issues
61
watchers
18
size
265 MB
created
last push

Subject data from GitHub, linked at the top of this page, refreshed . Test data by Argusic (CC BY 4.0); every number links to a run page with the full log, the recording, and their sha256 hashes.

What was measured

From the run that decided this verdict. Every line is a recorded value, not an estimate.

Time lost to each failure while testing readme-ai, drawn from the recorded run
Every bar is a failure the agent recorded, with the time it cost. Drawn from this run, not from anywhere else.

What went wrong, in the agent's own words

The agent's own words, worst first, never rewritten into advice.

  • tiktoken 0.4.0 requires Rust compiler (rustc) to build from source and no prebuilt wheel is available for cp3121 minute
Install time
2 minutes
Cold machine to finish
3 minutes
Errors hit and fixed
1 hit, 1 fixed with no human help
How the result was proved
`poetry run pytest tests/ -v --no-header --tb=no -q` exited with '373 passed, 5 skipped, 3 warnings'
Model tokens used
78,624
Exact commit tested
6f507b5f8779
Container image
sha256:cdd920bce783

What was not measured

The other half, so you can see exactly how far this evidence goes. A gap is printed as a gap and never filled in.

Peak GPU memory
this ran on a CPU machine, so there was no GPU to sample
Behaviour over a long run
each attempt uses the smallest documented settings and a fixed time budget, so this measures whether it runs, not how it holds up under load

The end of the recording

The last lines of the terminal session that decided this verdict, exactly as they were recorded.

\"" in /work/repo
 succeeded in 0ms:
Install duration: 1.5 minutes
Real now: 1794316729.6407714
Now let me compile the final report.
Here's the full report:
**ARGUSIC_RESULT:** {"install_succeeded": true, "launch_succeeded": true, "install_minutes": 1.5, "…
tokens used
78,624
Now let me compile the final report.
Here's the full report:
**ARGUSIC_RESULT:** {"install_succeeded": true, "launch_succeeded": true, "install_minutes": 1.5, "…

Replay the whole session, every command from a clean machine to this point.

How it was tested

One agent, one container, no human help. It installs the project the way its own documentation says to, runs it, and fixes what breaks. Everything below is recorded as it happened: the terminal session, the log and the exact commit. The full method.

Strengths and limits

Measured facts, not opinions. How this is written.

What went well

  • Reached a running state on a clean machine, with the session recorded.
  • Installed in 1.5 minutes, faster than the median of the 40 comparable projects Argusic has measured.
  • Recovered from all 1 error without a human stepping in, which says the failures are documented well enough to solve.
  • Ran without a GPU, so it does not need one to start.
  • Licensed MIT, as reported by its host.
  • Measured 2 times, so the result is not a one-off.

Of the 41 agents projects Argusic has installed and timed, readme-ai was the 7th fastest to reach a running state, and 29 of 41 reached one at all.

What it is a reasonable choice for

  • Trying it on a laptop or a small server: it reached a running state without a GPU.
  • A quick evaluation: it was running 1.5 minutes after the clone.

Also tested, in the same area

Every one of these was installed and run by Argusic on a clean machine. Nothing appears here that was not tested.

Run history

tested byattemptoutcomescorecost USDwhen
Argusic Runner2/3Runs100.000.03
Argusic Runner1/3Runs100.000.04

Topics (from GitHub)

agentsaiai-agentsai-documentationanthropicbadge-generatorclideveloper-toolsdevtoolsdocumentationdocumentation-generatorgeminigptmarkdownmarkdown-generatorpythonreadmereadme-generatorreadme-md-generatorreadme-template

Embed the badge

Markdown for the project README. It links back here; terms on the terms page.

[![Tested by Argusic](https://argusic.com/badge/readme-ai.svg)](https://argusic.com/subject/readme-ai)

Questions

Does readme-ai run?
Yes. readme-ai runs. Argusic installed and launched it on a clean machine in 2 minutes, hitting 1 error on the way, and recorded the session.
How did Argusic test readme-ai?
On a fresh, disposable machine, with every command recorded and the repository pinned at commit 6f507b5f8779. 2 attempts are recorded, and the full method is on the methodology page.
What did it cost to test readme-ai?
The run that produced this verdict cost $0.03: real compute and model cost, not a list price per million tokens. It is recorded on that run's page.
How long does readme-ai take to install?
1.5 minutes in the run that decided this verdict, from a clean machine to a running state. That is one measured attempt, not an average.
Does readme-ai need a GPU?
Not to start. Argusic reached a running state on a machine with no GPU.
What goes wrong when installing readme-ai?
1 thing broke in the recorded run, and 1 were fixed without human help. Each one, and the time it cost, is listed on this page.
How does readme-ai compare with the alternatives?
Of the 41 agents projects Argusic has installed and timed, readme-ai was the 7th fastest to reach a running state, and 29 of 41 reached one at all.
Where is the evidence for readme-ai?
All 2 recorded runs are on this page, each linking to its full log and terminal recording, stored with a sha256 fingerprint so it cannot be quietly altered.

Discussion