Commit fd2aed3a authored by Amit Kumar Bala's avatar Amit Kumar Bala

Update readme

parent 45630b14
...@@ -3,15 +3,17 @@ Team Name - Quad-core ...@@ -3,15 +3,17 @@ Team Name - Quad-core
Project - Protracktor - Local Proctoring and Activity Tracker Project - Protracktor - Local Proctoring and Activity Tracker
Date: 17th November, 2020 Date: 17th November, 2020
------------------------------------------------------------- -------------------------------------------------------------
Contributors: Contributors:
Amit Kumar Bala Antu (203051003 - antukbala) Amit Kumar Bala Antu (203051003 - antukbala)
Kunal Verma (203050121 - kunalverma) Kunal Verma (203050121 - kunalverma)
Nimesh Agrawal (203050049 - nimesh) Nimesh Agrawal (203050049 - nimesh)
Mallela Niteesh Kumar (203050065 - niteesh) Mallela Niteesh Kumar (203050065 - niteesh)
Shubhranshu Maurya (203050096 - shubhranshu) Shubhranshu Maurya (203050096 - shubhranshu)
Git Repository Git Repository
-------------- --------------
*Cloning the Repository *Cloning the Repository
link of git repo: https://git.cse.iitb.ac.in/nimesh/Protracktor.git link of git repo: https://git.cse.iitb.ac.in/nimesh/Protracktor.git
use git clone <url> to clone the repo use git clone <url> to clone the repo
...@@ -58,6 +60,8 @@ After that run the following command in terminal: ...@@ -58,6 +60,8 @@ After that run the following command in terminal:
$ python3 main.py $ python3 main.py
This will start the application. This will start the application.
Using the program Using the program
------------------ ------------------
The main window has two tabs namely "Local Proctoring" and "Let's Start". The main window has two tabs namely "Local Proctoring" and "Let's Start".
...@@ -65,26 +69,35 @@ The main window has two tabs namely "Local Proctoring" and "Let's Start". ...@@ -65,26 +69,35 @@ The main window has two tabs namely "Local Proctoring" and "Let's Start".
2) This field is used to name the log files and video files with additional timestamps added as a naming convention for files 2) This field is used to name the log files and video files with additional timestamps added as a naming convention for files
3) Click on "Next" to move to the next tab "Let's Start" 3) Click on "Next" to move to the next tab "Let's Start"
On clicking next after entering the course code you will be directed to the next tab ("Let's Start" tab). On clicking next after entering the course code you will be directed to the next tab ("Let's Start" tab).
Here there are four check boxes named according to the functionalities they will provide, namely: Here there are four check boxes named according to the functionalities they will provide, namely:
a) Webcam Recording a) Webcam Recording
b) Screen Recording b) Screen Recording
c) Activity Manager c) Activity Manager
d) Data usage per app d) Data usage per app
Check on the required functionalities you want monitored during the proctoring. Check on the required functionalities you want monitored during the proctoring.
***Note***: Internet loss triggered - Webcam and screen recording will only start if there is a loss in internet connectivity detected. ***Note***: Internet loss triggered - Webcam and screen recording will only start if there is a loss in internet connectivity detected.
This assumes that you are already on some proctoring platform like ms teams initially and if there is a loss of internet connectivity then only webcam recording will start. This assumes that you are already on some proctoring platform like ms teams initially and if there is a loss of internet connectivity then only webcam recording will start.
After checking on the appropriate check boxes you can start the monitoring by clicking on "Start" button. After checking on the appropriate check boxes you can start the monitoring by clicking on "Start" button.
After clicking on start a new pop-up window will open. After clicking on start a new pop-up window will open.
Notifications Notifications
------------- -------------
Two types of notification are issued to the user during the proctoring. Two types of notification are issued to the user during the proctoring.
- When Internet goes down. - When Internet goes down.
- When Internet comes back. - When Internet comes back.
Terminating the program Terminating the program
----------------------- -----------------------
Whenever you want to stop the proctoring/monitoring just click on the stop button. Whenever you want to stop the proctoring/monitoring just click on the stop button.
This will close the application also. This will close the application also.
All the corresponding outputs will be saved in the "Results" directory in the main folder. All the corresponding outputs will be saved in the "Results" directory in the main folder.
Viewing the Results/outputs/graphs Viewing the Results/outputs/graphs
---------------------------------- ----------------------------------
1) The "Proctoring" option in menu bar will direct you to various log files and graphs generated by the software. 1) The "Proctoring" option in menu bar will direct you to various log files and graphs generated by the software.
...@@ -105,5 +118,3 @@ Viewing the Results/outputs/graphs ...@@ -105,5 +118,3 @@ Viewing the Results/outputs/graphs
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment