Improved the readme file and added some documentation

F.R.I.D.A.Y-windows/requirements.txt

@@ -1,4 +1,4 @@
-SpeechRecognition==3.8.1 
+pythSpeechRecognition==3.8.1 
 pywhatkit==5.3 
 wikipedia==1.4.0 
 PyAutoGUI==0.9.53 

README.md

@@ -1,45 +1,164 @@
-# FRIDAY-virtual-assistant
+# FRIDAY-Virtual-Assistant
 
-An AI assistant that automates Linux or windows system on voice
+Do you want things to get executed just from your voice command? Well, it's possible now, thanks to FRIDAY, an AI virtual assistant that automates Linux or Windows system on voice.
 
-<h1 align=center>
+<div align=center>
   <img alt="Skylon Logo" src="https://github.com/rpj09/FRIDAY-virtual-assistant/blob/master/assets/Friday.png?raw=true" width=800 height=600 ><br>
-</h1>
+</div>
+<br>
 
+Are you a tech enthusiast? So what are you waiting for? <br>
+Follow the instructions below to use this AI virtual assistant!
 
+## HOW TO RUN ON YOUR LOCAL SYSTEM?
 
+## For Linux Users
 
-### HOW TO RUN?
+### Clone the repository
 
-```shell
-#clone the repository
+```
 git clone https://github.com/rpj09/FRIDAY-virtual-assistant
+```
+
+```
 cd F.R.I.D.A.Y-linux
+```
+
+### Now enter your details in eemail.py and online_class_links.py
 
-# For windows replace F.R.I.D.A.Y-linux with F.R.I.D.A.Y-windows
-#Now enter your details in eemail.py and online_class_links.py
+```
 """
             'email':'xxx@gmail.com',    -->enter you own email
             'password':'abc',           -->enter you own password
             'administrator':'xxx@gmail.com',  -->other reciepents
             'admin':'xxx@gmail.com',
 """
+```
+
+### Install the dependencies
 
+```
 pip install -r requirements.txt
 
-#
+```
+
+### Run the program
+
+```
 python main.py
+
+```
+
+## For Windows Users
+
+### Clone the repository
+
+```windows
+
+git clone https://github.com/rpj09/FRIDAY-virtual-assistant
+```
+
+```
+cd F.R.I.D.A.Y-windows
+```
+
+### Now enter your details in eemail.py and online_class_links.py
+
+```
+"""
+            'email':'xxx@gmail.com',    -->enter you own email
+            'password':'abc',           -->enter you own password
+            'administrator':'xxx@gmail.com',  -->other reciepents
+            'admin':'xxx@gmail.com',
+"""
 ```
 
+### Install the dependencies
 
-### SUPPORTED PLATFORMS
+```
+
+pip install -r requirements.txt
+
+```
+
+### Run the main program
+
+```
+
+python main.py
+
+```
+
+## TECHSTACKS USED IN THIS PROJECT
+
+![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
+
+## Getting Started
+
+Are you a tech enthusiast? Want to enhance the features of this project? <br>
+Follow the steps mentioned below to contribute to this project:
+
+**1.** Fork [this](https://github.com/rpj09/FRIDAY-virtual-assistant) repository.
+
+**2.** Clone your forked copy of the project.
+
+```
+git clone https://github.com/<your_user_name>/FRIDAY-virtual-assistant.git
+
+```
+
+where **your_user_name** is your GitHub username.
+
+**3.** Navigate to the project directory.
+
+```
+cd FRIDAY-virtual-assistant
+
+```
+
+**4.** Create a new branch.
+
+```
+git checkout -b <your_branch_name>
+
+```
+
+**5.** Make necessary changes and commit them to the main branch via a pull request.
+
+**6.** Track the changes you made.
+
+```
+git add .
+
+```
+
+**7.** Commit your changes.
+
+```
+git commit -m "what changes you made"
+
+```
+
+**8.** Push the committed changes in your feature branch to your remote forked repo.
+
+```
+git push origin <your_branch_name>
+
+```
+
+**9.** To create a pull request, head to your forked repository and click on `Compate and pull request`. Please check that you are comparing your feature branch to the desired branch of the repo you are supposed to make a PR to.
+
+**10.** Explain your pull request to the maintainers via adding appropriate title and description to your pull request explaining your changes and efforts done.
+
+**11.** Then, click on `Create pull request` .
+
+**12.** Congratulations 🥳, you've contributed to this project. After you are done creating a pull request to this project, be patient while your PR is reviewed.
+
+## SUPPORTED PLATFORMS
 
 _NOTE: This project has cross-platform support but requires a bit of tweaking to
 support platforms other than linux_
 
 - [x] Linux
-- [x] Windows 
+- [x] Windows
 - [ ] Mac (requires minor changes)
-
-
-