diff --git a/INSTALLATION.md b/INSTALLATION.md new file mode 100644 index 0000000..096ea17 --- /dev/null +++ b/INSTALLATION.md @@ -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 + +
+ Click here for Windows setup instructions + +### 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". + + Windows protected your PC prompt + +* 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. + + Newer Windows Firewall prompt for Allow Windows Firewall prompt for Allow access + +
+ +## MacOS + +
+ Click here for MacOS setup instructions + +### 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. + +