Skip to content

Commit 10cd73c

Browse files
Clarify Windows and WSL development docs (#13)
1 parent 458bfa4 commit 10cd73c

3 files changed

Lines changed: 13 additions & 7 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Current product behavior:
2929

3030
## Environment Model
3131

32-
- Development and editing happen in WSL.
32+
- Development and editing can happen in Windows or WSL.
3333
- Official Windows installers are built in GitHub Actions on `windows-latest`.
3434
- Do not treat WSL as the place to produce final Windows distributables for users.
3535
- Python target is `3.13`.
@@ -266,7 +266,7 @@ If changing packaging or release behavior, verify:
266266
- No signing pipeline is integrated yet.
267267
- SmartScreen reputation is not solved in the current repo state.
268268
- Installer localization is still separate from runtime localization.
269-
- The app is Windows-only at runtime even though development happens in WSL.
269+
- The app is Windows-only at runtime even though development may happen in Windows or WSL.
270270
- Teams or similar presence behavior is not guaranteed by the keep-awake methods.
271271

272272
## Practical Guidance For Future Agents

CONTRIBUTING.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
# Contributing
22

3-
Trayffeine is developed in WSL, but the real product is a Windows tray app.
4-
Keep that split in mind when changing runtime behavior, packaging, or tray UX.
3+
Trayffeine can be developed from Windows or WSL, but the real product is a
4+
Windows tray app. Keep that split in mind when changing runtime behavior,
5+
packaging, or tray UX.
56

67
## Local Setup
78

9+
For WSL or Linux-style shells:
10+
811
```bash
912
python3.13 -m venv .venv
1013
. .venv/bin/activate
1114
python -m pip install -e .[dev]
1215
python scripts/generate_assets.py
1316
```
1417

15-
For packaging work on Windows:
18+
For Windows PowerShell and packaging work:
1619

1720
```powershell
1821
py -3.13 -m venv .venv
@@ -31,6 +34,9 @@ ruff check .
3134
pytest
3235
```
3336

37+
On Windows PowerShell, use `.venv\Scripts\Activate.ps1` before running the same
38+
`ruff check .` and `pytest` commands.
39+
3440
These checks do not prove real tray behavior on Windows. If you touch
3541
`pystray`, dialogs, packaging, notifications, or startup integration, do a real
3642
Windows run as the final confidence step.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Trayffeine is a small Windows tray application that keeps the computer awake while a session is active. It is inspired by tools such as Caffeine, but focuses on a native tray workflow, configurable keep-awake methods, persistent preferences, and a simple installer pipeline.
44

5-
Development happens in WSL, but official Windows installers are produced in GitHub Actions on `windows-latest`.
5+
Development can happen in Windows or WSL, but official Windows installers are produced in GitHub Actions on `windows-latest`.
66

77
## Version 1.1.2
88

@@ -241,7 +241,7 @@ Environment override:
241241

242242
### WSL workflow
243243

244-
Use WSL for editing, linting, and tests:
244+
Use this loop for WSL or Linux-style shells:
245245

246246
```bash
247247
python3.13 -m venv .venv

0 commit comments

Comments
 (0)