Update README.md

This commit is contained in:
justin committed 2026-04-01 19:25:07 -07:00
1 parent 5b58e84d38
commit 16aa0f1d90
1 file changed
+21
+21
View File
@@ -53,6 +53,19 @@ From the root of this repository, run:
python3 install.py python3 install.py
``` ```
By default this uses the `default` build environment. To use a different environment pass `-e`:
```bash
python3 install.py -e slim
python3 install.py -e gh_release
```
| Environment | Description |
|-------------|-------------|
| `default` | Debug logging enabled, version from current git branch (recommended) |
| `gh_release` | Info logging only, version hardcoded to release tag |
| `slim` | No serial logging, smallest binary size |
The installer will: The installer will:
1. Clone the CrossPoint Reader source repository 1. Clone the CrossPoint Reader source repository
@@ -99,6 +112,14 @@ $env:PATH += ";$env:USERPROFILE\.platformio\penv\Scripts"
[Environment]::SetEnvironmentVariable("PATH", $env:PATH, "User") [Environment]::SetEnvironmentVariable("PATH", $env:PATH, "User")
``` ```
If you installed Python from the Microsoft Store, the scripts folder is in a different location. Run this instead to find and add it:
```powershell
$scripts = (Get-ChildItem "$env:USERPROFILE\AppData\Local\Packages" -Filter "Scripts" -Recurse -ErrorAction SilentlyContinue | Where-Object { $_.FullName -like "*Python*" } | Select-Object -First 1).FullName
$env:PATH += ";$scripts"
[Environment]::SetEnvironmentVariable("PATH", $env:PATH, "User")
```
Restart your terminal and re-run `install.py`. Restart your terminal and re-run `install.py`.
## Adding a Plugin ## Adding a Plugin