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 20 minutes and hit 5 errors and fixed every one without help on a clean machine with no GPU, and the whole session was recorded.
readmeai installs in a venv, passes its full 373-test suite, and generates README output files via the CLI in offline mode. The pyproject.toml dependency bounds were relaxed from caret to minimum versions to avoid Rust-compiler requirements for newer prebuilt wheels.
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
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.
What went wrong, in the agent's own words
The agent's own words, worst first, never rewritten into advice.
- tiktoken failed to build from source (no Rust compiler)5 minutes
- Missing click and other runtime deps (dependency resolver didn't install them due to version conflicts)3 minutes
- poetry.core.masonry.api missing for editable install1 minute
- Missing optional anthropic package1 minute
- Missing optional google-generativeai package1 minute
- Install time
- 20 minutes
- Cold machine to finish
- 5 minutes
- Errors hit and fixed
- 5 hit, 5 fixed with no human help
- How the result was proved
- pytest: 373 passed, 5 skipped, 0 failed. readmeai --version prints 0.6.0.rc1. readmeai --repository . --api offline --output /tmp/test_readme.md generated a 42791-line README.md file without errors.
- Model tokens used
- 65,385
- 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.
succeeded in 904ms: readmeai version 0.6.0.rc1 All tasks completed successfully. Here's the summary: **Install:** Created a venv, configured dependencies, relaxed overly tight version pins in `pyproje… **Launch:** `readmeai --version` prints `0.6.0.rc1`, `readmeai --help` lists all options, and runni… **Tests:** `pytest` reports **373 passed, 5 skipped, 0 failures**. tokens used 65,385 All tasks completed successfully. Here's the summary: **Install:** Created a venv, configured dependencies, relaxed overly tight version pins in `pyproje… **Launch:** `readmeai --version` prints `0.6.0.rc1`, `readmeai --help` lists all options, and runni… **Tests:** `pytest` reports **373 passed, 5 skipped, 0 failures**.
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.
- Recovered from all 5 errors 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.
What did not, or is not known
- Took 20 minutes to install, slower than the median of the 20 comparable projects Argusic has measured.
- Measured once so far. A single attempt shows it can run, not that it runs reliably.
Of the 21 agents projects Argusic has installed and timed, readme-ai was the 19th fastest to reach a running state, and 12 of 21 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.
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
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.
[](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 20 minutes, hitting 5 errors 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. One attempt is 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.04: 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?
- 20 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?
- 5 things broke in the recorded run, and 5 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 21 agents projects Argusic has installed and timed, readme-ai was the 19th fastest to reach a running state, and 12 of 21 reached one at all.
- Where is the evidence for readme-ai?
- The recorded run is on this page, each linking to its full log and terminal recording, stored with a sha256 fingerprint so it cannot be quietly altered.