chore: update readme

README.md

@@ -1,3 +1,23 @@
-# desktop-qa-automation
+# This repository manages UI tests for desktop application
 
-https://www.notion.so/Pytest-framework-8705e8ad28994330ae4ced9dccd87394
+## How to set up your environment
+
+1. **MacOS**: https://www.notion.so/Mac-arch-x64-and-Intel-50ea48dae1d4481b882afdbfad38e95a
+2. **Linux**: https://www.notion.so/Linux-21f7abd2bb684a0fb10057848760a889
+3. **Windows**: https://www.notion.so/Windows-fbccd2b09b784b32ba4174233d83878d
+ 
+**NOTE:** when MacOS and Linux are proven to be working, Windows guide could be outdated (no one yet set up Windows)
+
+## Which build to use
+
+1. you _can_ use your local dev build but sometimes tests hag there. To use it, just place a path to the executable to AUT_PATH in your _local.py config,
+for example `AUT_PATH = "/Users/anastasiya/status-desktop/bin/nim_status_client"`
+
+2. normally, please use CI build. Grab recent one from Jenkins job https://ci.status.im/job/status-desktop/job/nightly/
+
+    **2.1** Linux and Windows could be taken from nightly job
+    ![img.png](img.png)
+
+    **2.2** Mac **requires entitlements**  for Squish which we don't add by default, so please go here https://ci.status.im/job/status-desktop/job/systems/job/macos/
+and select architecture you need (arm or intel), click Build with parameters and select Squish entitlements. Select a branch if u like (master is default)
+    ![img_1.png](img_1.png)