Add readme documentation.

namruthahari / Sample-Git-Repo

The repository is to practice git commands!

2 stars 20 forks source link

Add readme documentation. #2

Open namruthahari opened 3 years ago

namruthahari commented 3 years ago

Type a suitable description appropriate for the repository in readme.md file.

Shivam-Shrivastav commented 3 years ago

You can write description for a particular repository in your readme.md file as follows:

This repo contains source code of XYZ project and the features of this XYZ project are as follows:

xyz
- abc
xyz2
- abc2
- abc3

Secondly

If you want the viewers to pull your project in their system and install your project, then provide them with the requirements and step wise procedure to run your project in their system

namruthahari commented 3 years ago

Sure!! I will add them. I am new to git so learning to make issues and to use readme! I made this project for my friends to learn git! Thanks for the info will add them ASAP!