Skip to content

Commit 5426978

Browse files
docs: enhance Python virtual environment setup instructions for development workflow
1 parent 2b8b5d1 commit 5426978

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

.github/copilot-instructions.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,32 @@ This is firmware for DIY astronomical telescope mounts, built on Zephyr RTOS v4.
2020
2121
## Development Workflow
2222
23+
### Python Virtual Environment Setup
24+
This project uses Python tools for development and testing. A virtual environment is recommended:
25+
```bash
26+
# Create and activate virtual environment
27+
python3 -m venv .venv
28+
source .venv/bin/activate # Linux/macOS
29+
# .venv\Scripts\activate # Windows
30+
31+
# Install Zephyr SDK and development dependencies
32+
pip install west
33+
pip install -r zephyr/scripts/requirements.txt
34+
```
35+
36+
**Note**: `.venv/` directory is gitignored and contains Python packages for:
37+
- `west` - Zephyr workspace management tool
38+
- `devicetree` - Device tree compiler and tools
39+
- `ply` - Python parsing library for Kconfig
40+
- Development and testing utilities
41+
42+
### Load virtual Environment (needed for each terminal session)
43+
```bash
44+
# Activate the virtual environment
45+
source .venv/bin/activate # Linux/macOS
46+
# .venv\Scripts\activate # Windows
47+
```
48+
2349
### West Workspace Setup (Required)
2450
This project uses west workspace management. Must be initialized properly:
2551
```bash

0 commit comments

Comments
 (0)