Initial commit
This commit is contained in:
122
commands/badge-quickstart.md
Normal file
122
commands/badge-quickstart.md
Normal file
@@ -0,0 +1,122 @@
|
||||
---
|
||||
description: Verify your development environment is ready for badge development
|
||||
---
|
||||
|
||||
# Badge Quick Start Checklist
|
||||
|
||||
Run through a complete environment verification checklist to ensure everything is set up correctly for Badger 2350 development.
|
||||
|
||||
## What to Check
|
||||
|
||||
Run verification commands and report status for each step:
|
||||
|
||||
### 1. Python Installation
|
||||
```bash
|
||||
python3 --version
|
||||
```
|
||||
**Expected**: Python 3.8.0 or higher
|
||||
|
||||
**If missing**: Provide installation instructions for user's OS:
|
||||
- macOS: `brew install python3`
|
||||
- Linux: `sudo apt install python3 python3-pip python3-venv`
|
||||
- Windows: Download from https://python.org/downloads/
|
||||
|
||||
### 2. Virtual Environment
|
||||
Check if user is in a virtual environment:
|
||||
```bash
|
||||
echo $VIRTUAL_ENV
|
||||
```
|
||||
|
||||
**If not active**:
|
||||
```bash
|
||||
# Create virtual environment
|
||||
python3 -m venv venv
|
||||
|
||||
# Activate it
|
||||
source venv/bin/activate # macOS/Linux
|
||||
venv\Scripts\Activate.ps1 # Windows PowerShell
|
||||
```
|
||||
|
||||
### 3. mpremote Installation
|
||||
```bash
|
||||
mpremote --version
|
||||
```
|
||||
|
||||
**If missing**:
|
||||
```bash
|
||||
pip install mpremote
|
||||
```
|
||||
|
||||
### 4. Badge Connection
|
||||
```bash
|
||||
mpremote exec "print('Badge connected!')"
|
||||
```
|
||||
|
||||
**Expected**: "Badge connected!" printed
|
||||
|
||||
**If fails**:
|
||||
- Check USB-C cable (must be data cable, not charge-only)
|
||||
- Try different USB port
|
||||
- Check badge is powered on
|
||||
- On Linux: May need to add user to `dialout` group
|
||||
|
||||
### 5. badgeware Module
|
||||
```bash
|
||||
mpremote exec "from badgeware import screen, brushes, shapes, io; print('✓ badgeware loaded'); print('✓ Display: 160x120'); print('✓ All OK')"
|
||||
```
|
||||
|
||||
**Expected**: All ✓ marks shown
|
||||
|
||||
**If fails**:
|
||||
- Badge may need firmware update
|
||||
- Check USB connection is stable
|
||||
- Try pressing RESET button once
|
||||
|
||||
## Results Summary
|
||||
|
||||
After running all checks, provide a summary:
|
||||
|
||||
✅ **All checks passed!** You're ready to start developing.
|
||||
|
||||
Or identify what needs fixing:
|
||||
|
||||
⚠️ **Issues found**:
|
||||
- [List any failed checks]
|
||||
- [Provide specific fix commands]
|
||||
|
||||
## Next Steps
|
||||
|
||||
If all checks pass, suggest:
|
||||
|
||||
1. **Create your first app**:
|
||||
```
|
||||
/create-badge-app my_first_app
|
||||
```
|
||||
|
||||
2. **Browse example apps**:
|
||||
Check `examples/hello_world` and `examples/meditation_timer` in this plugin
|
||||
|
||||
3. **Read the API reference**:
|
||||
```
|
||||
/badgeware-api
|
||||
```
|
||||
|
||||
4. **Get detailed help**: Use the `badger-quickstart` skill for step-by-step guide
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If verification fails, run:
|
||||
```
|
||||
/troubleshoot <issue>
|
||||
```
|
||||
|
||||
For comprehensive diagnostics, use the `badger-diagnostics` skill.
|
||||
|
||||
## Detailed Setup Guides
|
||||
|
||||
For complete setup instructions, refer to these skills:
|
||||
- **badger-quickstart**: Complete beginner guide (30-45 min)
|
||||
- **python-setup**: Detailed Python environment setup
|
||||
- **badger-2350-dev**: Development toolchain reference
|
||||
|
||||
You can invoke skills by asking Claude to use them when you need more detailed help.
|
||||
Reference in New Issue
Block a user