How to create a pretty README.md file

In each project we need to have a small description that explain how to use , deploy and install it, usually we put this in a file called README.md , so here i will write an example that will be usable for most of your projects.

In your project root create a file called README.md

It will appear like this in your git repo:

README.md file for a node project

Put this content into it

<p align=”center”>
<a href=”” rel=”noopener”>
<img width=200px height=200px src=”” alt=”Project logo”></a>
</p>

<h3 align=”center”>MyProject</h3>
— — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — -

<p align=”center”> Few lines describing your project.
<br>
</p>

## 📝 Table of Contents

- [About](#about)
- [Getting Started](#getting_started)
- [Deployment](#deployment)
- [Structure](#structure)
- [Running the tests](#tests)
- [Built Using](#built_using)
- [Authors](#authors)

## 🧐 About <a name = “about”></a>

Write about 1–2 paragraphs describing the purpose of your project.

## 🏁 Getting Started <a name = “getting_started”></a>

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.

### Prerequisites

What things you need to install the software and how to install them.

```
Give examples
```

### Installing

A step by step series of examples that tell you how to get a development env running.

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo.

## 🔧 Running the tests <a name = “tests”></a>

Explain how to run the automated tests for this system.

### Break down into end to end tests

Explain what these tests test and why

```
Give an example
```

### And coding style tests

Explain what these tests test and why

```
Give an example
```

## 🎈 Structure <a name=”structure”></a>

Describe your project structure if there is not a framework like ‘node js’ || Add notes about how to use the system such as ‘Laravel projects’

## 🚀 Deployment <a name = “deployment”></a>

Add additional notes about how to deploy this on a live server.

## ⛏️ Built Using <a name = “built_using”></a>

List used technologies for your project like this :

- [MongoDB](https://www.mongodb.com/) — Database
- [Express](https://expressjs.com/) — Server Framework
- [ReactJs](https://reactjs.org/) — Front Framework
- [NodeJs](https://nodejs.org/en/) — Server Environment

## ✍️ Authors <a name = “authors”></a>

- [Fares Karbia](https://twitter.com/fares_karbia):

--

--

--

Software engineer with a passion for developing innovative programs that expedite the efficiency and effectiveness of organizational success.

Love podcasts or audiobooks? Learn on the go with our new app.

Recommended from Medium

Free data analysis & visualization tool for startups

Could the new WordleBot enhance the game?

New in MicroStation CONNECT Edition Update 15 — DWG Key-ins and RealDWG 2021 support

Anthos Series Part 2 : Multi-cluster management - IBM, Google, MicroSoft and Private

A short (and simple) introduction to algorithm profiling

How much can you schlep?

Creating a Retro Game Over Behavior

Story of a Smart and Passionate 10 year Old Boy who Loves Coding

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store
Fares Karbia

Fares Karbia

Software engineer with a passion for developing innovative programs that expedite the efficiency and effectiveness of organizational success.

More from Medium

Understand how to use Git pull requests in 1 minute.

Dependency Injection in under 2minutes

Clean Coding and Test Driven Development : A beginner’s introduction to software development — I

An image to vaguely represent coding.

Setting Up Multiple Git Profiles for Fun, Work, and Profit