Patternflow is moving from a single public build guide toward a set of build paths, pattern tools, and community contributions.
This file is intentionally a starting point. The contribution process will become more detailed as more people build, test, and modify Patternflow.
- Build Patternflow and share photos, problems, and notes.
- Improve the build documentation when a step is unclear.
- Test alternate build paths, especially breadboard electronics and future laser-cut enclosure files.
- Suggest better sourcing options for parts.
- Share custom patterns with the community.
- Report firmware, web, or documentation issues.
Custom patterns are welcome as community work, but official bundled firmware patterns will be curated for now. If you make something interesting, share it in the Discord patterns channel (follow the post guidelines there) or open an issue with the source.
Licensing — inbound = outbound. By sharing a pattern (Discord, issue, or PR) you agree to license it under CC-BY-SA 4.0 — the same commons as the rest of Patternflow — with attribution kept in the code header (// Author: and // SPDX-License-Identifier: CC-BY-SA-4.0). There is no copyright assignment (no CLA): you keep authorship, and the project just gets the right to bundle and redistribute it. You may set a different license in the header as long as it still lets the project bundle and redistribute the pattern.
Project rules and guidelines are currently under consideration and will be finalized in the future.
- Assembly map: docs/assembly/README.md
- Current full build guide: BUILD_GUIDE.md
- Custom patterns: firmware/CUSTOM_PATTERNS.md
- Discord: discord.gg/Vr9QtsxeTk