A collection of documentation for WLAN Pi developers and contributors.
New to WLAN Pi development? Start here:
- Getting Started - Set up your environment and make your first contribution
- Git Workflow Guide - Git fundamentals (if you're new to Git)
- Contributing - Detailed workflow guidelines
- Packaging Example - Create your first package
To set up a WLAN Pi device for development (requires curl and sudo):
curl -vfSL http://wlanpi.us/install | sudo bash| Document | Description |
|---|---|
| Getting Started | Development environment setup and first contribution guide |
| Git Workflow Guide | Git fundamentals for beginners |
| Contributing | Detailed Git workflow, branch naming, PR guidelines, and code review |
| Packaging Example | Complete walkthrough of creating a Debian package from scratch |
| Document | Description |
|---|---|
| Release Process | Tagging, versioning, and deployment procedures |
| Document | Description |
|---|---|
| Filesystem Hierarchy | Directory structure standards (/opt, /etc, /var) |
| Debian Packaging | Packaging policy and required files |
| Document | Description |
|---|---|
| Contributing Style | Code contribution standards |
| Python | Python coding standards |
| Packaging Style | Packaging-specific style guide |
| Anti-patterns | Common mistakes to avoid |
| Debchange | Changelog formatting |
| Developer Workflow | Development process standards |
| Document | Description |
|---|---|
| Development Setup | Detailed environment setup |
| IDE Setup | IDE configuration |
| Developing on Windows | Windows/WSL development guide |
| Update from Dev Branch | Testing dev packages |
| VSC Remote-SSH | VS Code troubleshooting |
| Document | Description |
|---|---|
| Licensing | Project licensing policy (MIT) |
| Document | Description |
|---|---|
| Code of Conduct | Community standards |
We welcome your feedback. Feel free to open an issue with suggestions and rationale for any proposed changes.
External resources for learning:
- GitHub Git Guide - Official GitHub resources
- Oh Shit, Git!?! - Practical Git problem solving
- Git from the Bottom Up - Deep Git internals
- Debian New Maintainers' Guide - Debian packaging
- dh-virtualenv Documentation - Python packaging tool
