Package for public GitHub release
Add open-source scaffolding and CI; remove Claude-specific dev notes from the published tree. - Remove CLAUDE.md from tracking (kept locally, now git-ignored). - CHANGELOG.md (Keep a Changelog; v1.0 → v1.1.1). - SECURITY.md (private vuln reporting + operator guidance). - CONTRIBUTING.md (dev setup, conventions, PR flow). - .github/: bug + feature issue templates, PR template. - .github/workflows/ci.yml: byte-compile, validate example config, docker build. - .github/workflows/release.yml: on a version tag, publish a multi-arch (amd64 + arm64) image to GHCR. - README: license/release/CI badges, prebuilt-image (GHCR) run instructions, and a corrected Python-version note (3.9–3.11; netifaces caveat). Badges and image names use an `OWNER` placeholder to replace with the GitHub namespace after the repo is created. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -1,5 +1,11 @@
|
||||
# ADS-Bit
|
||||
|
||||
[](LICENSE)
|
||||
[](https://github.com/OWNER/ADS-Bit/releases)
|
||||
[](https://github.com/OWNER/ADS-Bit/actions/workflows/ci.yml)
|
||||
|
||||
> **Setup note:** replace `OWNER` with your GitHub username/org throughout this README (badges and image names) after creating the repository.
|
||||
|
||||
A retro SNES-style side-view flight tracker that displays ADS-B aircraft data with custom pixel art sprites.
|
||||
|
||||

|
||||
@@ -41,7 +47,21 @@ On first run, visit http://localhost:2001 and the setup wizard will guide you th
|
||||
|
||||
- [Docker](https://docs.docker.com/get-docker/) with Compose V2, **or** [Podman](https://podman.io/) with `podman-compose`
|
||||
|
||||
### First Run
|
||||
### Run the prebuilt image (no clone needed)
|
||||
|
||||
Once a release is published, a multi-arch image (amd64 + arm64, e.g. Raspberry Pi)
|
||||
is available from GitHub Container Registry:
|
||||
|
||||
```bash
|
||||
docker run -d --name ads-bit --network host --restart unless-stopped \
|
||||
-e ADSBIT_CONFIG=/app/data/config.json \
|
||||
-v "$PWD/data:/app/data" \
|
||||
ghcr.io/OWNER/ads-bit:latest
|
||||
```
|
||||
|
||||
Then open http://localhost:2001 and complete the setup wizard.
|
||||
|
||||
### Build from source
|
||||
|
||||
```bash
|
||||
# Build and start — no config step needed
|
||||
@@ -92,7 +112,7 @@ Host networking (`network_mode: host`) is used so the server can auto-scan your
|
||||
|
||||
## Requirements
|
||||
|
||||
- Python 3.8+
|
||||
- Python 3.9–3.11 (3.12+ may require build tools for `netifaces`; the Docker image uses 3.11)
|
||||
- ADS-B receiver providing SBS/BaseStation format on port 30003 (dump1090, readsb, etc.)
|
||||
- Modern web browser with Canvas support
|
||||
|
||||
|
||||
Reference in New Issue
Block a user