What is README file ?

📅 May,2020
✍🏻 Aditya Panda

README file is a markdown file which helps to describe your projects on github.

no image

A README is like the face of your project.

Introduction

If you are into software development you might have headed over to github and explored some repositories. In these repositories developers upload there programs and software to share it with community.
In most of the repositories you might have seen a README.md file, This Readme file is a markdown file which is used to describe the info, working and installation of the project. If you are a developer and upload projects on github then you should know how to write a good readme.md file to make your projects standout.

What is Markdown?

Markdown is plain text formatting syntax used for writing purposes on the internet. It is a text-to-html conversion tool which allows you to write easy-to-read and easy-to-write plain text format , then converts it to structurally valid html.
Markdown is widely used in blogging, online Forums, collabrative forums and documentation purposes.

Lets see the syntax for writing a markdown.

Markdown have some specefic syntax to format the text and it should be written properly to be converted into structured HTML.

Headers Emphasis Lists Links Images Codes Quotes

To write Headers is Markdown file we use # symbol.

Syntax

# Header 1 - this will create a h1 heading.

## Header 2 - this will create a h2 heading.

### Header 3 - this will create a h1 heading.

    Output

Heading 1

Heading 2

Heading 3

- Emphasis

This Syntax is Used to make text bold or italic.

Syntax

_text1_ - this will make the text italic.

**text2** - this will make the text bold.

~~text3~~ - this will create a strikethrough text

    Output
text1

text2

text3

- Lists

This Syntax is used to create ordered or unordered lists.

Syntax

To Create Ordered Lists

1. abc
2. xyz
3. uvw

To Create Unordered Lists

- abc
- xyz
- uvw

    Output

Ordered list

  1. abc
  2. xyz
  3. uvw

Unordered list

This Syntax is Used to Create links in markdown file.

Syntax

[Text you want to show](link url)

[Send me a connection request on linkedin](https://linkedin.com/in/aditya-panda)

    Output
Send me a connection request on linkedin

- Images

This Syntax is Used to add Image, Screenshot or gif to your markdown file.

Syntax

Waterfall Image

![Alt text](Image link)

![Image is Loading](https://images.pexels.com/photos/327394/pexels-photo-327394.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=650&w=940)

    Output
Waterfall image
image is Loading

- Codes

This Syntax is Used to add Code Blocks. You can also specify your programming language so texts get highlighted.

Syntax

For Inline code use (`)

`const name="Aditya"`

For blocks of Code

```
const name = "Aditya";
console.log(name)

```

    Output
Inline Code
const name = "Aditya"
blocks of code
const name = "Aditya"
console.log(name)

- Quotes

This Syntax is Used to Write quotes in markdown file.

Syntax

> Keep Smiling and Work Harder

    Output
| Keep Smiling and Work Harder


So, Thats all i have mentioned all the Syntax i Know. Also you can refer to the original markdown documentation for more syntax and Information.

An Ideal README.md Should have

  1. Project title
  2. Project description
  3. Tech Stack Used
  4. How to run this project
  5. Credits
  6. Conclusion
  7. Future Scope
  8. References

Yeah that's it by me!!!. If you like this blog do share it with your friends so that they can also learn about README file.
Also folow me on linkedin, twitter or github for more tech updates.


Go Back to Blogs Go to top