概览
模板是分享给其他人使用的 PicoPixel 项目文件。用户可以在现有布局、控件和样式的基础上继续设计,无需从空白画布开始。
模板通过 GitHub 提交。请准备一个公开仓库,包含 .picopixel 文件、展示图片和介绍模板的 README。通过审核后,模板会出现在社区模板库中,并显示你的署名,供其他人浏览和使用。
本指南介绍如何准备仓库、填写表单,以及提交时需要了解的授权条款。
开始前的准备
- GitHub 账号:模板仓库必须托管在 GitHub。没有账号的话,请先注册。
- 完成的设计文件:确认设计无误后,从 PicoPixel 导出
.picopixel文件,准备上传到仓库。
提交表单需要登录后才能访问。打开 PicoPixel 应用,使用 Google 或 GitHub 登录即可。
准备 GitHub 仓库
为模板创建一个新的公开 GitHub 仓库,并放入以下内容:
1. .picopixel 文件
将最终版 .picopixel 文件放在仓库根目录,用户会下载这个文件并在 PicoPixel 中打开。
2. 展示图片
提供能展示模板效果的图片,帮助用户在下载前了解设计。
- 放在仓库根目录或
images/等文件夹中。 - 使用
.png、.jpg或.webp等常见格式。 - 至少提供一张界面运行时的截图;多屏项目可以展示多个屏幕。
- 图片应清楚展示细节,同时避免文件过大。
3. README 说明
在仓库根目录创建 README.md。它会作为模板详情页的介绍,建议写清楚:
- 模板用途:这是什么设计,适合用来做什么。
- 目标分辨率与硬件:面向哪种开发板或显示屏,方便用户判断是否适合。
- 包含内容:列出屏幕、控件和主要功能。例如:“包含主仪表盘和设置页两个屏幕,提供滑块、开关和时钟控件。”
- 作者与素材来源:如果使用了获准分享的第三方素材,请注明名称和来源。
把 README 写给第一次看到这个项目的人。能让读者弄清楚“它是什么、是否适合我的项目”,就是一份有用的说明。
下面是一份简短的英文示例:
# Weather Dashboard Template
A clean two-screen weather dashboard designed for 320×240 TFT displays.
## What's included
- **Home screen** — current temperature, humidity, and a 3-day forecast row
- **Settings screen** — unit toggle (°C/°F), update interval slider, and Wi-Fi status
## Built for
- 320×240 resolution
- ILI9341 or similar TFT displays
## Credits
Weather icons from [Meteocons](https://bas.dev/work/meteocons) (MIT license).填写提交表单
仓库准备好后:
- 打开 PicoPixel 应用并登录。
- 点击左侧边栏底部的账号,选择 Your account。
- 在账号设置侧边栏中打开 Submit Template。
填写以下字段:
- GitHub Repo Link:公开仓库的链接,例如
https://github.com/yourname/my-template。仓库必须公开,审核团队才能访问。请确认其中包含.picopixel文件、图片和 README。 - Author / Credits:希望显示的作者署名,也可以列出共同作者。
- Notes(可选):供审核团队查看的补充说明,例如哪些图片不适合公开展示,或不便写入公开介绍的项目背景。
确认无误后提交表单。
权利与授权
提交模板即表示同意相应授权,请在提交前仔细阅读。
请勿提交未经授权的受版权保护内容。仓库中的 .picopixel 文件、图片、字体、图标及其他素材,都必须是你自己的作品,或已取得明确的公开分享许可。
提交后,你授权 PicoPixel 访问、下载并在社区模板库中公开发布仓库内容。发布的模板将不附带版权限制或许可要求,任何人都可在自己的项目中自由使用,包括商业用途。页面会保留你的署名,模板本身则允许他人自由使用。
因此,请只提交你愿意按上述条件分享的作品。如果某些字体、图标、图片或其他素材并非由你创作,而且你无法确认是否有权不受限制地分享,请先移除。无法确认授权的素材,不应随模板提交。
PicoPixel 可能移除侵犯第三方权利的内容,详情见服务条款。