How to write your first README file??

We all been in a stage where we wondered how do these README files are written on sites like GitHub, GitLab, Dev.to, etc.

Writing a README file is no rocket science; it’s actually quite simple

So, walk along with me, and by the end of this blog, you’ll learn how to write your own README file.

README files are written using Markdown, which is why they have the file extension “.md”

Let’s get started with writing your first README file.

# Hello World

I'm learning markdown language the easiest way.

Preview:

Explanation:

The “#” at the beginning makes the text an H1 heading, while plain text is considered as normal text. Wasn’t it simple to get started?

Just like that we can have,

• H1, H2, H3 headings
• Bold & Italic text
• Ordered & Unordered List
• Code snippet
• Horizontal line
• Link
• Image, and much more.

There’s a lot we can do using Markdown. Here are some basic syntax examples:

Syntax:

• Heading

# This is an H1
## This is an H2
### This is an H3

• Bold text

**This is some bold text**

• Italic text

*This is some italic text*

• Ordered List

1. First item
2. Second item
3. Third item

• Unordered List

- First item
- Second item
- Third item

For more syntax examples, you can refer: Markdown Cheatsheet

This is how it looks like,

Besides basics, markdown has extended its syntax to Emojis, Subscript, Superscript, Highlight,..

Bonus: To create Readme files and instantly preview how they will look, you can visit Readme.so

That’s all for this blog. Thank you for reading my first blog post.

I hope you enjoyed it and learned something new.