DEV Community

Allair Joshua
Allair Joshua

Posted on • Edited on

ReadMeSensei – AI-Powered README Generator

This is a submission for the Agent.ai Challenge: Productivity-Pro Agent (See Details)

What I Built

ReadMeSensei is an AI-powered agent that automatically generates structured and professional README.md files for any software project.

Writing a well-structured README is essential for making projects accessible to developers and users. However, many new developers struggle to create this, and in my case, a way to start it. ReadMeSensei simplifies this by automatically extracting project details and generating a comprehensive README, while trying to ensuring all critical sections (installation, usage, dependencies, etc.) are included.

Currently you will have to navigate to your main script (main.py etc) and send that as input, working on a way to make the entire github repo as an input, couldn't do it as per personal time issues.

Demo

https://agent.ai/agent/README-Sensei

Image description

Agent.ai Experience

Agent AI was very easy to bring up ideas try to visualize them, had some issues with the serverless function calls and such but on a whole it is great and fun to use.

Top comments (0)