1 min read

Readme AI

Readme AI

Today, I decided to complete the README.md file for my project with my groupmates (SST Inc Project Serve). Since it was open source, it made sense to me that I needed to create a file to explain to people what we did. That's when I came across a memory. I recently saw a TikTok where a person just placed the link of a GitHub repository into a website, and a README file was generated instantly. I thought that today was the perfect time to do it, and therefore, I decided to do some research. At last, I found this website:

https://www.gitread.dev/

This was the website where I placed the link to my GitHub repository, and it generated my README immediately. I really liked how simple it was to use this platform, and I recommend it to people who want to save time when developing open-source software. Even if your website or software is not open-source, you should still create a README so that colleagues/partners or other people can understand the code and what it does, and the necessary configurations when they start coding.

Downside

They have a limited number of credits you can have based on the date this was published, so you might have to pay for it or look for alternatives.