DEV Community 👩‍💻👨‍💻

Cover image for Generate beautiful README in 10 seconds
Franck Abgrall
Franck Abgrall

Posted on

Generate beautiful README in 10 seconds

Hi 👋

A well structured and beautiful README is very important, especially for opensource projects. This is the first thing that visitors will see when they discover your project.

This is why I created readme-md-generator, a tool that generates beautiful basic README.md files with less efforts !

All you need to do is answer a few questions, and readme-md-generator will do the rest 👌

readme-md-generator is able to read your environment (package.json, git config...) to suggest you default answers during the README.md creation process :

demo

Generated README.md :

cli output

Feel free to check out the github repos if you're interested !

Top comments (33)

Collapse
 
daveskull81 profile image
dAVE Inden

I love this. Great idea! READMEs are super important and can be very daunting, especially to a beginner. I love this as a way to create a useful README for a project. It creates something that could stand alone or be a great starting point with a lot of the boilerplate in place.
My only question is, did you use the project itself to generate the README for the project? :)

Collapse
 
moopet profile image
Ben Sinclair

Why would it be daunting to create a readme? At least, why would it be any more difficult for someone new to things that downloading, installing and running an app?

Collapse
 
daveskull81 profile image
dAVE Inden

A README is meant to be a detailed document that describes what a project is, how to install it, and how to use it. It also needs information on things like how to contribute to the project. That can be a lot to think about, especially for a beginner who is still working out how to make their project work. One can end up putting a lot of pressure on themselves unnecessarily when thinking about everything that goes into a document like this. Having a nice boilerplate process takes a lot of the guess work out of the process and makes it more achievable to great something useful to others.

Thread Thread
 
moopet profile image
Ben Sinclair

What I guess I mean is, why does it help for this to be an app, why not just a template Markdown or text file?

Thread Thread
 
mindsers profile image
Nathanaël CHERRIER

I think because it is more interactive using an app. Interactive tools are fun to use. Also with a template you could miss some fields, not with a tool that asks you for the informations.

Thread Thread
 
moopet profile image
Ben Sinclair

With a template you could add sections as you need to for future projects without forking and hacking someone else's app.

Thread Thread
 
daveskull81 profile image
dAVE Inden

I agree with Nathanaël. Interactive tools can be very effective in making sure one doesn't miss things or at least knowingly skips them. Like when starting a new project with npm init it is helpful to have an app make sure you get everything right from the start.
But, this isn't for everyone. For some folks it may be just as easy to have a repo with all of the starting points they need. Now that Github has template repos one could easily have this setup in their account and use it to get going on a project.

Collapse
 
kefranabg profile image
Franck Abgrall Author

Yes I used the generator for the README :p thank you so much for your feedback !

Collapse
 
daveskull81 profile image
dAVE Inden

That's great!

Collapse
 
vagoel profile image
Varun

Franck ,this is so Good.I always find difficulties remembering markdown syntax and creating readme files.
Using this project , I will never be lazy again in creating consistent ,useful and beautiful readme files.

Thanks a lot.

Collapse
 
unnitmetaliya profile image
Unnit Metaliya

This seems exactly like something I was looking for all over on the internet. And, thought about creating something similar. But, you did a great job. If I want, I will fork your repo and contribute some features for sure if they come in my mind. For now, I have starred it. 👌👍

Collapse
 
douglasamarelo profile image
Douglas "Amarelo" Lopes

Hey, cool!

It is usually difficult and annoying to create a readme file. There is no standard way of doing this, everyone has to create their own and it is not always simple and easy to understand.
With this tool, we have a well-planned and structured way of doing this.

Well done. This is a very good tool.

Thanks for sharing.

Collapse
 
hagnerd profile image
Matt Hagner

This looks great! Can't wait to give it a spin.

Collapse
 
peterj profile image
Peter Jausovec

this looks great! now I have to go back to every github repo I have, and re-generate readmes :)

Collapse
 
jcoelho profile image
José Coelho

Wow! Great idea! This is what I need at work, most of my colleagues have never written a Readme file. 😒

Collapse
 
maheshkay profile image
Mahesh K

Thank you. I tested it. Really handy tool. :)

Collapse
 
simplycorey profile image
Corey McCormick

Great work! Now only if I could have my documentation for my projects created so easily. 🤔

Collapse
 
tonythetiger323 profile image
Tony Greeley

This is amazing! Great work! Thank you!

Collapse
 
theredspy15 profile image
Hunter Drum

I have many repos without a readme. This will fix that! Thank you!

Collapse
 
azza85 profile image
aaron

Great idea Franck! Keep up the good work!

Collapse
 
thluiz profile image
Thiago Luiz Silva

Wow!!! Great!

Collapse
 
codestuff2 profile image
Adam Whitlock

This is really awesome! Great job. I'm totally using this on new projects.

Collapse
 
vip3rousmango profile image
Al Romano

This is awesome!!!! :D

Some comments may only be visible to logged-in visitors. Sign in to view all comments.

This post blew up on DEV in 2020:

js visualized

🚀⚙️ JavaScript Visualized: the JavaScript Engine

As JavaScript devs, we usually don't have to deal with compilers ourselves. However, it's definitely good to know the basics of the JavaScript engine and see how it handles our human-friendly JS code, and turns it into something machines understand! 🥳

Happy coding!