Artifact for the paper: "READU: Inconsistency-Driven Just-in-Time Detection and Repair of README Bugs".
The artifact contains the READU implementation, benchmark runner, and datasets used for the paper.
Model-backed runs support DeepSeek or OpenRouter. Export one provider key before running Docker (OpenRouter is used in the examples):
export OPENROUTER_API_KEY=...To use DeepSeek directly, replace OPENROUTER_API_KEY in both the export and Docker --env option with DEEPSEEK_API_KEY.
Runs use deepseek-v4-flash by default. If both provider keys are present, DEEPSEEK_API_KEY takes precedence.
Docker is the only required runtime. Run the complete READU pipeline on a GitHub commit from the directory where output should be saved:
docker run --rm -it --env OPENROUTER_API_KEY -v "$PWD":/workspace/data/01_logs ghcr.io/doehyunbaek/readu:latest https://github.com/torvalds/linux/commit/933f05f58ac6014eaac387d22a76ace8606891d1Generated logs and artifacts are written to the current host directory. Cloned repositories are discarded when the container exits.