Sample Readme File

Why this is important?

This is the first file a person will see when he looks at your project. A good developement team will always maintain a readme file which serves the purpose.

This should Typically include below points

• Configuration Instruction
• Installation instruction
• Operating instruction
• A file manifest (Directory)
• Copyright and Licensing Information

Rapid Exchange ( Your readme file should start with your project name)

Table of Content

(TOC gives an overview of the content availabel in the file. It also make easier for the user to navigate directly to the required section)

• Project Description
• Technologies Used
• Folder Structure
• Install and Run
• Documentation

Project Description

( A short description about the project helps the user to understand the scope)

The Rapid Exchange protocol aim to provide solution for quick exchange of crypto token through smart contract.

Technologies Used

(List of technology or external libraries used)

• Soldity
• Openzepplein
• Hardhat

A typical top-level directory layout

.
├── build                   # Compiled files (alternatively `dist`)
├── docs                    # Documentation files (alternatively `doc`)
├── src                     # Source files (alternatively `lib` or `app`)
├── test                    # Automated tests (alternatively `spec` or `tests`)
├── tools                   # Tools and utilities
├── LICENSE
└── README.md

Install and Run

( This should include how to install, run and deploy the porject)

• Run npm install to install dependencies
• Run npx hardhat compile to compile all contracts

Test

(This should inlcude how to test the files)

Documents

(This should have link to the documents which describes the fucntions of contracts. This can be an external Link or PDf stored in project folder)