Super simple GitHub profile Readme generator made with Vue.js, that allows you to create beautiful Readme files that you can copy/paste in your profile.

What is a GitHub profile Readme? Check out the repository to learn more.

Make a README is inspired by Keep a Changelog. A changelog is another file that is very useful for programming projects. More Documentation. A README is a crucial but basic way of documenting your project. Now you have two branches, main and readme-edits. They look exactly the same, but not for long! Next we’ll add our changes to the new branch. Make and commit changes. Now, you’re on the code view for your readme-edits branch, which is a copy of main. Let’s make some edits. On GitHub, saved changes are called commits.

Markdown Tips:

• To bolden the text, wrap it with two asterisks (*) (**word**)
• To italisize the text, wrap it with one asterisk (*) (*word*)
• To strikethrough the text, wrap it with two tildes (~) (~~word~~)
• To make a link, place the link text in brackets and the url in parentheses ([link](http://example.com))
• To make an image, place an !, the alt text in brackets, and the url in parentheses (![github](/images/icon.png))

Write well formatted README. Each repository in Github can have a README file, which supports markdown format. It’s highly recommended to have README for every repository and if the project is a library, you’d better put detailed instructions in it. Maybe use Issues to track bugs. Do you know about the latest feature that Github released few months back, that let’s you show Beautiful and Dynamic profile with just a simple README.md file. If not, then you should totally check this out, it’s Super Cooool. In this blog, we are going to create a profile readme that will look something like this in the end. 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!

Learn more: https://guides.github.com/features/mastering-markdown/

Header

Readme File Github

Social information

Github User Readme

Example Github Readme