Skip to content
This repository was archived by the owner on Jul 18, 2026. It is now read-only.

Commit aa5d252

Browse files
rtibblesbotclaude
andcommitted
docs: update README for uv-based development setup
Replaces python.org installer instructions with uv. Removes stale Mac note about python.org requirement and virtualenv version pin. Updates the Requirements and Development Environment Setup sections. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent b3eac91 commit aa5d252

1 file changed

Lines changed: 7 additions & 12 deletions

File tree

README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
Cross-platform Kolibri app
33

44
### Requirements
5-
- **Python**: Version 3.10 is required.
5+
6+
- **uv**: Required for managing Python and dependencies.
7+
Install from [docs.astral.sh/uv](https://docs.astral.sh/uv/getting-started/installation/).
68

79
- **`wget`:** Required for downloading the Kolibri wheel.
810
- **Linux/macOS:** Usually preinstalled. You can verify by running `wget --version`.
@@ -30,14 +32,7 @@ Cross-platform Kolibri app
3032
- Windows (Git Bash)
3133

3234

33-
**Windows Note:** On Windows, there is a bug with PyInstaller and the latest virtualenv.
34-
If you're using virtualenv, please downgrade your virtualenv to version 16.1.0 until
35-
the bug is fixed.
36-
37-
**Mac Note:** Make sure you are using the
38-
[python.org Mac installer](https://www.python.org/ftp/python/3.6.8/python-3.6.8-macosx10.9.pkg)
39-
to install the package. Using pyenv, homebrew, etc. **will not work**. This is
40-
because they are configured differently from python.org builds.
35+
**Windows Note:** Build must be run in Git Bash on Windows.
4136

4237
**Note:** Builds must be run natively on the platform you're targeting.
4338

@@ -56,10 +51,10 @@ This step installs PyInstaller, pkginfo, and other Python packages required by t
5651
make dependencies
5752
```
5853

59-
- **Install Local Application Package (Optional):**
60-
If you plan to make changes to the kolibri-app wrapper code itself and want it recognized as an installed package in your environment, you can run:
54+
- **Install the Application Package (Optional):**
55+
If you plan to make changes to the kolibri-app wrapper code and want it recognized as an installed package in your environment:
6156
```
62-
pip install -e .
57+
uv sync
6358
```
6459

6560

0 commit comments

Comments
 (0)