mirror of
https://github.com/i12bp8/TagTinker.git
synced 2026-10-16 06:59:55 +00:00
HoggorminoandClaude Opus 5
53ede949b8
- README: the IR engine allocates heap for payloads, so drop
"zero-allocation"; the drop folder takes the 1-bit and two-plane BMPs
the image preparer exports, not any BMP, and type 1626 targets cap
files at 24 KB; NFC scan only fills the barcode when the tag's NFC
data decodes; there is no test-pattern feature; the FAQ now says this
app needs a Flipper even though the protocol does not.
- CONTRIBUTING: the Android companion app was removed in d608afb.
- wrangler.toml pointed users at a "WiFi Setup -> Server URL" field that
never existed. Say how the URL is actually set today.
- cloud_client.h described a runtime override through
cloud_client_set_url(), which nothing calls.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
44 lines
1.1 KiB
Markdown
44 lines
1.1 KiB
Markdown
# Contributing to TagTinker
|
|
|
|
Thanks for wanting to help out! Here's how to get involved.
|
|
|
|
## Getting Started
|
|
|
|
1. Fork the repo
|
|
2. Create a feature branch: `git checkout -b my-feature`
|
|
3. Make your changes
|
|
4. Test on hardware if possible (or at minimum, ensure `ufbt build` passes)
|
|
5. Commit with a clear message
|
|
6. Open a pull request
|
|
|
|
## Code Style
|
|
|
|
- C99, no C++ features
|
|
- 4-space indentation (no tabs)
|
|
- `snake_case` for functions and variables
|
|
- Keep functions short and focused
|
|
|
|
## What We're Looking For
|
|
|
|
- Bug fixes (especially memory-related — the Flipper has very limited heap)
|
|
- Support for new ESL tag sizes and models
|
|
- NFC tag support for additional ESL formats
|
|
- UI/UX improvements
|
|
|
|
## Pull Request Guidelines
|
|
|
|
- Use **"Create a merge commit"** when merging to preserve contributor attribution.
|
|
- Keep commits focused — one feature or fix per PR.
|
|
|
|
## Reporting Issues
|
|
|
|
Please open a GitHub issue with:
|
|
- What you expected to happen
|
|
- What actually happened
|
|
- Your Flipper firmware version
|
|
- The ESL model you're testing with (if applicable)
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contributions will be licensed under GPL-3.0.
|