DEV Community

Cover image for Create nice Readmes for your open source projects ✨
Avneesh Agarwal for ByteSlash

Posted on • Originally published at blog.avneesh.tech

Create nice Readmes for your open source projects ✨

Creating good Readmes for your open source project is very important to get some popularity, stars, forks, and contributors. So today we are going to look at 2 ways to create beautiful Readmes.

1. Readme-md-generator

This CLI tool generates a great looking in a few minutes. To use this tool run-

npx readme-md-generator
Enter fullscreen mode Exit fullscreen mode

After running this command, it will ask you a bunch of questions for adding in the readme.

image.png
After you have answered all the questions it will create a README.md file for you that looks like this-

Now you can edit and tweak it as per your need.

Quick hack

If you want to preview the readme directly hit ctrl + shift + V and it will show you a live preview.

image.png

2. Readme.so

If you want to build a more customized Readme, then this is a great tool built by @Katherine Peterson.

image.png

By just clicking some buttons and editing some text, I got a nice readme like this-

I hope you could make some nice Readmes for your open source projects with these amazing tools.

What tools do you use for making your Readme? Let me know in the comments 👇

Useful links-

Readme MD generator

Readme.so

All socials

Discussion (0)