Contributing
This project is in early development and welcomes help across hardware, firmware, server configuration, documentation, and testing.
Ways to Contribute
- Hardware: PCB design improvements, enclosure designs, and assembly documentation.
- Firmware: snapclient changes, HaLow driver integration, and audio quality improvements.
- Server: Snapserver configuration and additional audio source integrations.
- Documentation: Build guides, setup instructions, and troubleshooting notes.
- Testing: Range testing, latency measurements, and compatibility reports.
Getting Started
- Fork the repository.
- Create a feature branch:
git checkout -b feature/my-improvement. - Make your changes.
- Test your changes thoroughly.
- Commit with a clear message describing what changed and why.
- Open a pull request.
Development Setup
For server-side work, start with the Server Setup guide. For firmware work, use the Client Firmware guide and the separate snapclient_halow firmware fork.
License
By contributing, you agree that your contributions are licensed under the same MIT License that covers this repository. Firmware contributions to the snapclient fork are licensed under GPL-3.0 per the upstream license.