Polish project for public release

- Add requirements.txt with Python dependencies
- Add MIT LICENSE file
- Add screenshot for README
- Expand README with better documentation:
  - Quick start with git clone
  - Configuration example
  - Compatible receivers list
  - Custom backgrounds section
  - Credits section
- Update CONFIG.md:
  - Fix Quick Start checklist (add pip install step)
  - Add systemd service instructions for auto-start
- Remove CLAUDE.md from documentation list (dev-only file)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
root
2026-01-20 12:46:47 -08:00
parent 9cb0f42205
commit 6d33550081
5 changed files with 158 additions and 25 deletions

View File

@@ -217,8 +217,61 @@ All aircraft sprites should face **right (east)** - the code flips them automati
## Quick Start Checklist
1. [ ] Edit `config.json` with your receiver IP (or leave as AUTO)
2. [ ] Set your location name, latitude, and longitude
3. [ ] Replace `north.png`, `east.png`, `south.png`, `west.png` with your local views
4. [ ] Start the server: `python3 server.py`
5. [ ] Open browser to `http://your-server-ip:2001`
1. [ ] Install dependencies: `pip install -r requirements.txt`
2. [ ] Edit `config.json` with your receiver IP (or leave as AUTO)
3. [ ] Set your location name, latitude, and longitude
4. [ ] (Optional) Add custom backgrounds to `backgrounds/custom/` and set `"theme": "custom"`
5. [ ] Start the server: `python3 server.py`
6. [ ] Open browser to `http://your-server-ip:2001`
---
## Running as a Service (Auto-Start)
To run Pixel-ADSB automatically on boot, create a systemd service:
### 1. Create the service file
```bash
sudo nano /etc/systemd/system/pixel-adsb.service
```
Add this content (adjust paths as needed):
```ini
[Unit]
Description=Pixel-ADSB Flight Tracker
After=network.target
[Service]
Type=simple
WorkingDirectory=/path/to/pixel-view
ExecStart=/usr/bin/python3 /path/to/pixel-view/server.py
Restart=always
RestartSec=5
StandardOutput=append:/var/log/pixel-adsb.log
StandardError=append:/var/log/pixel-adsb.log
[Install]
WantedBy=multi-user.target
```
### 2. Enable and start the service
```bash
sudo systemctl daemon-reload
sudo systemctl enable pixel-adsb
sudo systemctl start pixel-adsb
```
### 3. Check status
```bash
sudo systemctl status pixel-adsb
```
### 4. View logs
```bash
tail -f /var/log/pixel-adsb.log
```