Skip to content

Commit d73a993

Browse files
committed
2 parents 21a923f + 2de8b0b commit d73a993

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,29 +20,34 @@ Oobee is available as a download for Windows and MacOS. Refer to [Installation G
2020
### Development and Testing
2121

2222
#### Set Engine Version
23+
2324
First open terminal and navigate to the location of clone respository of Oobee.
2425

2526
Then export BE_TAG to set version of Oobee (engine).
2627

2728
```shell
2829
export BE_TAG=0.9.48<version number>
2930
```
31+
3032
#### Build Standalone App
33+
3134
For Mac
3235

3336
```shell
3437
npm run make-mac
3538
```
39+
3640
For Windows
3741

3842
```shell
3943
npm run make-win
4044
```
4145

42-
This will create a folder in your repository in the *out* folder.
46+
This will create a folder in your repository in the _out_ folder.
4347
Enter and run the Oobee.app in the newly created folder in ../out.
4448

4549
#### Run and Debug
50+
4651
Enter the code below to build Oobee.
4752

4853
```shell
@@ -63,10 +68,9 @@ Open an [issue ticket](https://github.com/GovTechSG/oobee-desktop/issues) for as
6368

6469
---
6570

66-
6771
## Basic Usage
6872

69-
Enter a valid URL to scan in the textbox and press the "Scan" button. The default settings will crawl your website and scan 100 pages for accessibility issues.
73+
Enter a valid URL to scan in the textbox and press the "Scan" button. The default settings will crawl your website and scan 100 pages for accessibility issues.
7074

7175
![Oobee Desktop main page](https://github.com/user-attachments/assets/94d19cf8-88e4-46c3-b5d6-647b7c615a6e)
7276

@@ -236,17 +240,25 @@ Defaults to screen size of iPhone 11.
236240
Enter a custom width in pixels. Minimum width is 320px and Maximum width is 1080px.
237241

238242
## Report
239-
Once a scan of the site is completed.
243+
244+
Once a scan of the site is completed.
240245

241246
A report will be downloaded into the ../Documents folder.
242247

243-
An Address link to report is provided. Click on the link to access the location of the report.
248+
An Address link to report is provided. Click on the link to access the location of the report.
244249

245250
You can also click on the view report button to see the Accessibility Scan Results.
246251

247252
## Accessibility Scan Results
253+
248254
For details on which accessibility scan results trigger "Must Fix" / "Good to Fix" findings, you may refer to [Scan Issue Details](https://github.com/GovTechSG/oobee/blob/master/DETAILS.md).
249255

256+
## System Context Diagram
257+
258+
<img alt="System Context Diagram for Oobee" src="https://github.com/user-attachments/assets/9e9cd59c-46e4-46e0-b4d7-efa65d2757b8">
259+
260+
For Oobee's backed repository and to run Oobee as a command line, please refer to [Oobee (CLI)](https://github.com/GovTechSG/oobee).
261+
250262
## Additional Information on Data
251263

252264
Oobee uses third-party open-source tools that may be downloaded over the Internet during the installation process of Oobee. Users should be aware of the libraries used by examining `package.json`.

0 commit comments

Comments
 (0)