DEV Community

Henrique Sagara
Henrique Sagara

Posted on

ReadmeGenie Release 0.1

I'm happy to announce that I finished my first Open Source Project, Readme Genie Release 0.1.

As a junior developer, I struggle to document my projects and know what to add to my readme file.

That's why I created the Readme Genie as Release 0.1 for my Open-Source development class at Seneca College. It is a command-line tool designed to automatically generate detailed README.md files for your projects by utilizing the Groq API. It processes one or more source code files and returns a well-structured README.md file based on the content of those files.

I'm happy to have been introduced to the Open-Source community and to have the opportunity to create a project using AI.

Feel free to use and contribute to Readme Genie.

Top comments (0)

A Workflow Copilot. Tailored to You.

Pieces.app image

Our desktop app, with its intelligent copilot, streamlines coding by generating snippets, extracting code from screenshots, and accelerating problem-solving.

Read the docs

👋 Kindness is contagious

Please leave a ❤️ or a friendly comment on this post if you found it helpful!

Okay