Skip to content

Commit

Permalink
Create INSTALLATION.md
Browse files Browse the repository at this point in the history
  • Loading branch information
younglim authored Oct 25, 2024
1 parent 12fee48 commit 2da8cad
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Installation Guide

Oobee Desktop (formerly known as Purple A11y) is provided as a portable distribution which minimises installation steps required for Windows and Mac.

## About Oobee

Oobee is a customisable, automated accessibility testing tool that allows software development teams to find and fix accessibility problems to improve persons with disabilities (PWDs) access to digital services.

## System Requirements

* Oobee Desktop can run on MacOS Big Sur or above, and a [supported](https://learn.microsoft.com/en-us/windows/release-health/supported-versions-windows-client) version of Windows 10 (64-bit) or Windows 11.
* Google Chrome browser is [installed](https://www.google.com/chrome).
* One-time Internet access is needed to download and install Oobee Desktop.
* You are recommended to be logged on to an admin user to run Oobee Desktop.

## Windows

<details>
<summary>Click here for Windows setup instructions </summary>

### Download Oobee Desktop Windows

* Download [oobee-desktop-windows.zip](https://github.com/GovTechSG/oobee-desktop/releases/latest/download/oobee-desktop-windows.zip)
* Double-click the downloaded zip file. Extract the contents of the zip file with a right-click and choosing “Extract All” in the context menu.

### Run Oobee Desktop Windows

* Double-click the extracted Oobee-setup.exe file.
* If you see "Windows protected your PC" prompt as shown below, click "More info" and "Run anyway".

<img width="787" alt="Windows protected your PC prompt" src="https://github.com/GovTechSG/oobee-desktop/assets/2021525/6ec34301-26ce-41a5-9648-53d36e9198af">

* Follow the on-screen instructions to complete the setup process.
* Run Oobee Desktop from the Windows start menu.
* Oobee will start setting up. This process may take up to 5 minutes.

* If a Windows Firewall prompt appears, if you have administrator rights, click "Allow" or "Allow access". Click "Cancel" if you do not have administrator rights.

<img width="261" alt="Newer Windows Firewall prompt for Allow" src="https://github.com/GovTechSG/oobee/assets/50561219/4ece401b-1195-4a90-a327-243c081690b9"> <img width="331" alt="Windows Firewall prompt for Allow access" src="https://github.com/GovTechSG/oobee/assets/2021525/d6d435c4-f534-4416-b418-a8b8e15f3b3f">

</details>

## MacOS

<details>
<summary>Click here for MacOS setup instructions </summary>

### Download Oobee Desktop MacOS

* Download [oobee-desktop-macos.zip](https://github.com/GovTechSG/oobee-desktop/releases/latest/download/oobee-desktop-macos.zip).
* If Oobee app does not appear in your Downloads folder, double-click the Oobee file.

> Tip: To extract files in Mac, double-click on `oobee-desktop-macos.zip` file, which is usually saved to your Downloads folder. A new app `Oobee` with the a11y icon will appear. Drag or move `Oobee` app to your Applications folder for easy access.
### Run Oobee Desktop MacOS

* Double-click Oobee then click "Open" in the pop-up menu.
* Oobee will start setting up. This process may take up to 5 minutes.

</details>

0 comments on commit 2da8cad

Please sign in to comment.