DEV Community

Generate beautiful README in 10 seconds

Franck Abgrall on June 13, 2019

Hi 👋 A well structured and beautiful README is very important, especially for opensource projects. This is the first thing that visitors will see ...

Read full post

dAVE Inden • Jun 13 '19

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? :)

Ben Sinclair • Jun 14 '19

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?

dAVE Inden • Jun 14 '19

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.

Ben Sinclair • Jun 15 '19

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?

Nathanaël CHERRIER • Jun 15 '19

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.

Ben Sinclair • Jun 15 '19

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

dAVE Inden • Jun 15 '19

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.

Franck Abgrall • Jun 14 '19

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

dAVE Inden • Jun 14 '19

That's great!

Varun • Jun 17 '19

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.

Unnit Metaliya • Jun 14 '19

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. 👌👍

Douglas "Amarelo" Lopes • Jun 18 '19

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.