github-readme

To generate a GitHub README, provide your repository context, including the file tree, existing docs, and URL. The tool analyzes the provided repo structure to build accurate, repo-specific documentation instead of using generic templates.

Yes, you can rewrite an existing README by providing the current documentation and repository context. The tool enforces a practitioner technical tone and required section completeness while preventing fabricated content during the rewrite.

The best way to create repo-specific documentation is to trigger the tool with 'readme' or 'gr' and include your GitHub URL. It identifies the repository type and selects only sections that fit, avoiding irrelevant content.

Yes, it works with any repository type you provide context for. The tool performs repo-aware section selection, analyzing your file tree and notes to choose only the relevant sections that fit the specific repository.

The main limitation is that the tool strictly enforces no fabrication, meaning it cannot invent features not present in your provided context. It relies entirely on the file tree, existing docs, and URLs you supply to generate the README.

Your generated README includes only certain sections because the tool applies repo-aware section selection. It identifies your repository type and actively avoids generating irrelevant or fabricated content that does not fit your specific project.