diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db913a1..d2c710d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,18 @@ For the full macOS experience, run the installer from your checkout: ./scripts/install ``` -This starts the local server and menu bar companion. Open +On Windows, install with the per-user PowerShell workflow: + +```powershell +pwsh -NoProfile -File .\scripts\install-windows.ps1 +``` + +This stages the browser dashboard under `%LOCALAPPDATA%\Token Meter\runtime` +and registers automatic startup for the server and Windows system-tray widget. +The AppKit menu-bar companion is macOS-only; the Windows companion uses the +built-in PowerShell and WinForms runtime. + +The macOS installer starts the local server and menu bar companion. Open [http://localhost:8722](http://localhost:8722) and check its health with: ```bash @@ -54,7 +65,8 @@ curl http://127.0.0.1:8722/health ``` Rerun `./scripts/install` after source changes when you want to test the staged -runtime. For dashboard-only development, when port 8722 is free, run: +runtime; on Windows, rerun `install-windows.ps1`. For dashboard-only +development, when port 8722 is free, run: ```bash python3 meter.py @@ -104,6 +116,19 @@ node -e "const fs=require('fs'); const html=fs.readFileSync('page.html','utf8'); git diff --check ``` +On Windows, run the Python commands with the installed Python executable, parse +the PowerShell scripts, and exercise the Windows installer: + +```powershell +python -m py_compile meter.py token_meter_mcp.py +python -m unittest discover -s tests -v +node -e "const fs=require('fs'); const html=fs.readFileSync('page.html','utf8'); const m=html.match(/