You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-9Lines changed: 12 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@
14
14
<palign="center">
15
15
Shield is a Social Distancing Reminder app. The app will identify when another person (someone with a phone and the app) comes too close to you using BLE RSSI (Received Signal Strength Indicator). This will be useful in places such as universities and offices where everyone has a smartphone and will have the application installed.
16
16
<br />
17
-
<a href="https://github.com/kavindaperera/nova-shield/tree/development/docs"><strong>Explore the docs »</strong></a>
17
+
<a href="https://github.com/kavindaperera/nova-shield/tree/development/docs/NOVA_Shield_Documentation.pdf"><strong>Explore the docs »</strong></a>
@@ -67,12 +67,10 @@ The user can enter a nickname to be used within the app and simply press the <st
67
67
</p>
68
68
69
69
<palign="justify">
70
-
71
-
A user can start the Shield protection service by pressing the <imgsrc="./docs/ui/start_btn.png"alt="start"width="30"/> button on the bottom right corner of the home screen. This will start a simple animation on the home screen which indicates that the Shield protection is ON. The user can leave the app after this and still the application will be running in the background.
72
-
If the user needs to stop the Shield protection, then he/she needs to press the <imgsrc="./docs/ui/stop_btn.png"alt="pause"width="30"/> button.
73
-
70
+
Shield app requires the users to grant location access permission. When the user first launches the app, a pop-up dialog box will appear as shown in the first figure. The user can then select the Yes option which will open the phone’s settings. Then user can grant the required permission as shown in the second figure. In order to run the app, it needs phone’s Bluetooth to be turned on. If Bluetooth is not on, then a pop-up dialog as shown in the third figure will appear.
74
71
</p>
75
72
73
+
76
74
<palign="right">(<ahref="#top">back to top</a>)</p>
77
75
78
76
### Home
@@ -82,15 +80,20 @@ If the user needs to stop the Shield protection, then he/she needs to press the
82
80
</p>
83
81
84
82
<palign="justify">
85
-
Shield app requires the users to grant location access permission. When the user first launches the app, a pop-up dialog box will appear as shown in the first figure. The user can then select the Yes option which will open the phone’s settings. Then user can grant the required permission as shown in the second figure. In order to run the app, it needs phone’s Bluetooth to be turned on. If Bluetooth is not on, then a pop-up dialog as shown in the third figure will appear.
83
+
84
+
A user can start the Shield protection service by pressing the <imgalign="center"src="./docs/ui/start_btn.png"alt="start"width="30"/> button on the bottom right corner of the home screen. This will start a simple animation on the home screen which indicates that the Shield protection is ON. The user can leave the app after this and still the application will be running in the background.
85
+
If the user needs to stop the Shield protection, then he/she needs to press the <imgalign="center"src="./docs/ui/stop_btn.png"alt="pause"width="30"/> button.
86
+
86
87
</p>
87
88
89
+
90
+
88
91
<palign="right">(<ahref="#top">back to top</a>)</p>
<palign="right">(<ahref="#top">back to top</a>)</p>
@@ -105,8 +108,8 @@ Shield app requires the users to grant location access permission. When the user
105
108
106
109
<palign="justify">
107
110
A user can access the Friends Screen by pressing the Friends Tab on the bottom navigation bar.
108
-
By pressing the <imgsrc="./docs/ui/add_btn.png"alt="add"width="30"/> button on the bottom right corner, a user can get the Scan QR Code & Display QR Code options. Using the Scan QR Code option, a user can scan the Shield QR Code of a close friend and add him/her to the whitelist. Using the Display QR Code option, a user can show his/her Shield QR Code to another person to scan.
109
-
Once a user has added some friends to the whitelist, a <imgsrc="./docs/ui/dlt_btn.png"alt="delete"width="30"/> button is shown at the bottom right corner if the user wants to remove someone from the whitelist.
111
+
By pressing the <imgalign="center"src="./docs/ui/add_btn.png"alt="add"width="30"/> button on the bottom right corner, a user can get the Scan QR Code & Display QR Code options. Using the Scan QR Code option, a user can scan the Shield QR Code of a close friend and add him/her to the whitelist. Using the Display QR Code option, a user can show his/her Shield QR Code to another person to scan.
112
+
Once a user has added some friends to the whitelist, a <imgalign="center"src="./docs/ui/dlt_btn.png"alt="delete"width="30"/> button is shown at the bottom right corner if the user wants to remove someone from the whitelist.
110
113
</p>
111
114
<palign="right">(<ahref="#top">back to top</a>)</p>
0 commit comments