GitRead is an open-source developer tool that utilizes recent advances in large context window LLMs to automatically generate README files.

You can input any public GitHub repository, and it will automatically generate a README file for the codebase within 1-2 minutes.

I created this because I would often spend 1-2 hours writing up a perfect README file for each of my projects, and I thought generating them using an AI tool would make the process smoother.

I was inspired to create this project by GitIngest as well as the recent success of other tools like GitDiagram and DeepWiki.