loading...
Cover image for Generate beautiful README in 10 seconds

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 ...
pic
Editor guide
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
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
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
imshravan profile image
Shravan Kumar B

Hi, do check this project, to beautify your profile readme. Star it, if you like it.

GitHub Dynamic Animated Quote Generator

GitHub logo shravan20 / github-readme-quotes

Dynamic quote generator for your GitHub readmes

github-readme-quotes

Dynamic quote generator for your GitHub readmes

banner

alt PRs Welcome Open Source? Yes! GitHub contributors Pull Request Counts last commit deployment-status community chat

Github Readme Quotes

Copy and paste the following markdown content to display the quote.

![Quote](https://github-readme-quotes.herokuapp.com/quote)
Enter fullscreen mode Exit fullscreen mode

Themes

You can display your quote in different themes without any manual customization.

Use ?theme=THEME_NAME parameter as shown below.

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark)
Enter fullscreen mode Exit fullscreen mode

Available Themes

dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula

Gotham

Quote

Dark

Quote

Light Theme

Quote

You can explore different themes here.

Feel free to contribute different themes.

Layouts

You can also change the layout of your templates.

Use ?layout=LAYOUT parameter as shown below

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&layout=socrates)
Enter fullscreen mode Exit fullscreen mode

Layout 1 (Default)

Quote

Layout 2 (Socrates)

Quote

You can explore different layouts here.

Feel free to contribute different layouts.

Animations

You can also add animations to your templates.

Use ?animation=ANIMATION paramater as shown below

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&animation=grow_out_in)
Enter fullscreen mode Exit fullscreen mode

Animation 1

Quote

You can explore different animations…

Collapse
k_penguin_sato profile image
Collapse
hagnerd profile image
Matt Hagner

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

Collapse
azza85 profile image
aaron

Great idea Franck! Keep up the good work!

Collapse
theredspy15 profile image
Hunter Drum

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

Collapse
simplycorey profile image
Corey McCormick

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

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

Collapse
steffenpedersen profile image
Steffen Pedersen

This is pretty cool ✌🏻 It's great if you don't know how to start writing a README file.

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
javajunky profile image
Wil

I will try this on my next project.

Collapse
tonythetiger323 profile image
Tony Greeley

This is amazing! Great work! Thank you!

Collapse
sroy8091 profile image
Sumit Roy

How they generated their README.md file?

Collapse
gilton profile image
Gilton

Great post!! Thanks a lot!!

Collapse
jaredharbison profile image
JaredHarbison

I like it. I love it. Consistency and convention! For a future iteration... maybe a linkedin prompt along with github and twitter?

Collapse
kefranabg profile image
Collapse
arturssmirnovs profile image
Arturs Smirnovs

Nice, good job creating generator.. i made one my self for fun: arturssmirnovs.github.io/github-pr...