---
title: 'ARA: Auto README.md Agent'
emoji: 💻
colorFrom: red
colorTo: blue
sdk: gradio
sdk_version: 5.33.1
app_file: app.py
pinned: true
license: apache-2.0
short_description: Save your README.md writing time!
tags:
- agent-demo-track
---
<h1 style='text-align:center'>🤖 ARA: Auto README.md Agent 📝</h1>

## 👩‍🏫 Project Description
This project aims to draft README.md files using Hugging Face's smolagents library and open-source models.

## 💡 Project Purpose
- The README.md file serves as an important guide for people who are new to the repository.
- However, organizing the content in a readable and well-structured manner requires a significant time investment.
- For some, writing a README.md can be more challenging than writing the code itself.
- The goal is to enable an agent to autonomously understand the folder structure and key files, and draft an efficient README.md.

## 🛠️ Technology Stack
- Hugging Face
- Gradio
- Modallabs

## ⚠️ Limitations
- Currently works only with code written in Python.
- The agent's ability to understand repositories needs improvement.