11# Installation script instructions
22
33To install all required dependencies and configure your machine to run Puma, simply run the installation script for your
4- operating (` install_windows.bat ` , ` install_linux.sh ` or ` install_macos.sh ` ).
4+ operating system (` install_windows.bat ` , ` install_linux.sh ` or ` install_macos.sh ` ).
55
66# What does the script do?
77
88These scripts will:
9- 1 . install ADB and setup the required environmental values
10- 2 . install nodejs and appium
11- 3 . install Python 3.12
12- 4 . install Appium Inspector
13- 5 . install all requirements in your python virtual environment
9+ 1 . Install ADB and setup the required environmental values
10+ 2 . Install NodeJS and Appium
11+ 3 . Install Python 3.12
12+ 4 . Install Appium Inspector
13+ 5 . Install all requirements in your python virtual environment
1414
15- When software is installed (Adn , Node, Appium, Python, Appium inspector ), the scripts will only install the missing
15+ When software is installed (ADB , Node, Appium, Python, Appium Inspector ), the scripts will only install the missing
1616components. Python 3.12 will not be installed if you already have python 3.10, 3.11 or 3.12 installed.
1717
1818## ADB and environmental values
19- Puma needs adb to be installed and either be available on your path, or on ` ANDROID_SDK_ROOT/platform-tools/adb ` .
19+ Puma needs ADB to be installed and either be available on your path, or on ` ANDROID_SDK_ROOT/platform-tools/adb ` .
2020Appium ** requires** the environmental values ` ANDROID_SDK_ROOT ` or ` ANDROID_HOME ` to be set.
2121
2222The script will set these values if they aren't already set, and download the latest Android SDK platform tools and
@@ -27,14 +27,14 @@ Puma needs Appium, which is a Node.JS application.
2727The script will install Node.JS (through NVM on Linux and MacOS) and then use NPM to install Appium globally.
2828
2929## Python
30- Puma is tested on Python 3.10, 3.11 and 3.12. The script will install 3.12 if none of these versions is installed.
30+ Puma is tested on Python 3.10, 3.11 and 3.12. The script will install 3.12 if none of these versions are installed.
3131
3232## Appium inspector
33- Appium inspector is a tool that can help you develop new Puma code, either for new apps, or to expand functionality in
33+ Appium Inspector is a tool that can help you develop new Puma code, either for new apps, or to expand functionality in
3434existing apps.
3535
36- On Windows and MacOS it wil lbe installed as a regular application (through an installer), on Linux a portable binary
37- will be places in ` ~/.appium-inspector/appium-inspector.AppImage ` and an alias will be made so you can run it from
36+ On Windows and MacOS, it will be installed as a regular application (through an installer), on Linux a portable binary
37+ will be placed in ` ~/.appium-inspector/appium-inspector.AppImage ` and an alias will be made so you can run it from
3838the terminal using ` appium_inspector ` .
3939
4040## Installing requirements in the python virtual environment
0 commit comments