Skip to content

Commit 6e7ee78

Browse files
RobertFlattakshayaurora
authored andcommitted
Update installation.rst
1 parent 522ab4e commit 6e7ee78

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

docs/source/installation.rst

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@ Installation
22
============
33

44
Buildozer can be installed on Linux or Macos, Windows users must install WSL to use Linux.
5-
Target platforms are Android and iOS, iOS is only available for Buildozer MacOS installs.
5+
Target platforms are Android and iOS, iOS is only available for MacOS installs.
66
After Buildozer installation read the Quickstart documentation.
77

8+
This page contains install instructions for targeting Android or iOS. The Android section contains instructions
9+
for installing Buildozer on Ubuntu or on MacOS, also there are special notes for WSL users. Other Linux OS can
10+
be used (for example Colab) but there are no instructions. The iOS section
11+
contains instructions for installing kivy-ios on MacOS.
12+
813
Buildozer is tested on Python 3.8 and above.
9-
Depending the platform you want to target, you might need more tools installed.
10-
Buildozer tries to give you hints or tries to install few things for
11-
you, but it doesn't cover every situation.
1214

1315
Targeting Android
1416
-----------------
@@ -37,11 +39,12 @@ Note that the Rust on-screen instructions specify to add::
3739

3840
. "$HOME/.cargo/env"
3941

40-
to ~/.bashrc, and to open a new shell. Note the leading period above.
42+
to ~/.bashrc, and to open a new shell. The leading period in the line above above is important.
4143

4244
Activate an existing Python virtual environment, or create and activate a new Python virtual environment.
4345
Python 3.12 defaults to requiring a virtual environment::
4446

47+
cd
4548
virtualenv venv
4649
source venv/bin/activate
4750

@@ -70,21 +73,15 @@ Then install the buildozer project with::
7073

7174
pip3 install --user --upgrade buildozer
7275

73-
Install on Windows
74-
~~~~~~~~~~~~~~~~~~
75-
76-
To use Buildozer on Windows, you need first to enable Windows Subsystem for Linux (WSL) and
77-
`install a Linux distribution <https://docs.microsoft.com/en-us/windows/wsl/install>`_.
78-
79-
These instructions were tested with WSL2 with Ubuntu 20.04, 22.04, and 24.04. WSL1 has a known fatal issue.
76+
Notes for WSL users
77+
~~~~~~~~~~~~~~~~~~~
8078

81-
After installing WSL and Ubuntu on your Windows machine, open Ubuntu, follow the instructions above,
82-
and restart your WSL terminal to enable the path change.
79+
Legacy WSL1 users must upgrade to WSL2. WSL1 has a known fatal issue.
8380

84-
Copy your Kivy project directory from the Windows partition (under /mnt/c) to the WSL partition (under ~).
81+
Copy your Kivy project directory from the Windows file system (usually under /mnt/c) to the WSL file system (under ~).
8582

86-
It is important to use the WSL partition. Builds are about 5 times faster than the Windows partition,
87-
and using an NTFS partition on a Linux system may cause some Python packages to behave as if they are
83+
It is important to build on the WSL file system. Builds are about 5 times faster than the Windows file system,
84+
and using an NTFS formatted disk on a Linux system may cause some Python packages to incorrectly behave as if they are
8885
configured for Windows.
8986

9087
For debugging, WSL does not have direct access to USB. Copy the .apk file to the Windows partition and run ADB

0 commit comments

Comments
 (0)