Omówienie
Szablon to jeden z Twoich plików PicoPixel, udostępniony po to, aby inni mogli otworzyć go jako punkt startowy. Zamiast budować ekran od zera, zaczynają od Twojego układu, widżetów i stylów.
Szablony przesyła się przez GitHub. Tworzysz publiczne repozytorium zawierające plik .picopixel, obrazy prezentujące projekt, oraz README opisujące szablon. Po zaakceptowaniu szablon pojawia się w społecznościowej galerii Templates, gdzie każdy może go przeglądać i używać, z przypisaniem autorstwa do Ciebie.
Ten przewodnik przeprowadza przez konfigurację repozytorium, wypełnienie formularza, prawa, których udzielasz, oraz sposoby zwiększenia szansy na akceptację zgłoszenia.
Zanim zaczniesz
Przed przesłaniem przygotuj dwie rzeczy.
- Konto GitHub. Repozytorium szablonu musi być hostowane na GitHub. Jeśli nie masz konta, najpierw utwórz je.
- Gotowy projekt. Upewnij się, że jesteś zadowolony z pliku
.picopixel, zanim go prześlesz. Wyeksportuj go z aplikacji PicoPixel i przygotuj do dodania do repozytorium.
Aby uzyskać dostęp do formularza zgłoszeniowego, musisz być zalogowany w aplikacji PicoPixel. Otwórz aplikację PicoPixel i zaloguj się przez Google albo GitHub, jeśli jeszcze tego nie zrobiłeś.
Przygotowanie repozytorium GitHub
Utwórz nowe publiczne repozytorium GitHub dla zgłoszenia szablonu. Repozytorium powinno zawierać trzy rzeczy:
1. Twój plik .picopixel
Umieść plik projektu .picopixel w katalogu głównym repozytorium. To właśnie ten plik ludzie pobiorą i otworzą w PicoPixel, więc upewnij się, że jest to finalna wersja.
2. Obrazy prezentujące projekt
Dodaj obrazy prezentujące projekt obok szablonu w galerii. Pomagają one ludziom zobaczyć wygląd projektu przed pobraniem.
- Umieść obrazy w katalogu głównym repozytorium albo w folderze takim jak
images/. - Użyj popularnych formatów:
.png,.jpgalbo.webp. - Dodaj co najmniej jeden zrzut ekranu projektu w działaniu. Kilka ujęć albo ekranów jest jeszcze lepsze.
- Zachowaj rozsądny rozmiar obrazów — na tyle duży, aby było widać szczegóły, ale bez niepotrzebnego nadmiaru.
3. README
Napisz README.md w katalogu głównym repozytorium. Ten plik jest używany jako opis szablonu w galerii, więc potraktuj go jak publiczną stronę szablonu.
Dobre README powinno zawierać:
- Czym jest szablon — krótkie podsumowanie projektu i jego przeznaczenia.
- Docelową rozdzielczość i sprzęt — płytkę albo wyświetlacz, dla którego został zbudowany, aby ludzie wiedzieli, czy pasuje do ich konfiguracji.
- Co zawiera — listę ekranów, widżetów i kluczowych funkcji. Na przykład: "dwa ekrany: dashboard główny i strona ustawień, z suwakami, przełącznikami i widżetem zegara."
- Informacje o autorach — jeśli użyłeś zasobów firm trzecich, które masz prawo udostępniać, podaj ich nazwy i źródła.
Wyobraź sobie osobę, która trafia na Twój szablon w galerii bez żadnego innego kontekstu. Jeśli README odpowiada na pytanie "co to jest i czy zadziała u mnie?", robi swoją pracę.
Oto minimalny przykład:
# 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).Wypełnianie formularza
Gdy repozytorium jest gotowe, przejdź do formularza zgłoszeniowego.
- Otwórz aplikację PicoPixel i zaloguj się.
- Kliknij swoje konto na dole lewego paska bocznego, a potem wybierz Your account.
- W pasku bocznym konta otwórz Submit Template.
Formularz ma trzy pola:
- GitHub Repo Link — URL publicznego repozytorium GitHub (np.
https://github.com/yourname/my-template). Repozytorium musi być publiczne, aby zespół sprawdzający zgłoszenie miał do niego dostęp. Przed wysłaniem sprawdź, czy zawiera plik.picopixel, obrazy i README. - Author / Credits — nazwa, która ma być pokazana jako twórca szablonu. Dodaj też inne osoby, które powinny zostać wymienione.
- Notes (opcjonalnie) — wszystko, co zespół sprawdzający zgłoszenie powinien wiedzieć, a czego nie ma w README. Na przykład, jeśli niektóre obrazy nie powinny zostać użyte w opisie w galerii albo jeśli istnieje kontekst projektu, który nie pasuje do publicznego opisu.
Gdy wszystko wygląda dobrze, wyślij formularz.
Prawa i uprawnienia
Przesyłając szablon, udzielasz określonych praw do jego wykorzystania. Przed wysłaniem przeczytaj uważnie poniższe warunki.
Nie przesyłaj cudzych materiałów chronionych prawem autorskim bez odpowiedniej zgody. Wszystko w repozytorium — plik .picopixel, obrazy, czcionki, ikony i inne zasoby — musi być w całości Twoją oryginalną pracą albo materiałem, do którego masz wyraźne pozwolenie na publiczne udostępnienie.
Przesyłając szablon, udzielasz PicoPixel pozwolenia na dostęp, pobranie i publiczne udostępnienie zawartości repozytorium w społecznościowej galerii szablonów. Opublikowane szablony są udostępniane bez ograniczeń praw autorskich ani wymagań licencyjnych, aby każdy mógł swobodnie używać ich we własnych projektach, także komercyjnie. Twoje autorstwo zostanie wskazane, a inni będą mogli dowolnie korzystać z szablonu bez opłat.
Przesyłaj więc tylko prace, które chcesz udostępnić na takich warunkach. Jeśli jakakolwiek część projektu używa zasobu, którego nie stworzyłeś — czcionki, zestawu ikon, obrazu albo czegokolwiek innego — i nie masz pewności, że możesz udostępnić go swobodnie i bez ograniczeń, usuń go przed przesłaniem. W razie wątpliwości pomiń go: czysty szablon jest dla innych znacznie bardziej użyteczny niż taki, który trzeba później wycofać.
PicoPixel może usuwać treści naruszające prawa osób trzecich. Zobacz Regulamin.
Co dzieje się później
Po wysłaniu zespół PicoPixel klonuje repozytorium i sprawdza szablon. Podczas weryfikacji zespół sprawdza, że plik .picopixel otwiera się poprawnie, obrazy i README są odpowiednie, a zgłoszenie spełnia Regulamin.
Zespół może odezwać się, jeśli coś wymaga wyjaśnienia albo poprawy. Gdy szablon zostanie zaakceptowany, zostaje opublikowany w galerii Templates z informacją o autorstwie i opisem z README. Od tego momentu każdy może otworzyć go jako punkt startowy własnego projektu.
Zachowaj repozytorium po przesłaniu. Jeśli później chcesz zaktualizować szablon — naprawić błąd, podmienić obraz albo poprawić opis — możesz zaktualizować repozytorium i poinformować zespół.
Jeśli opublikowany szablon trzeba kiedyś poprawić albo usunąć (Twój lub cudzy), zobacz Jak zgłosić treść.
Dokąd dalej
- Galeria szablonów, przeglądaj szablony społeczności
- Jak zgłosić pupila, udostępnij animowany sprite
- Jak zgłosić treść, zgłoś problem ze pupilem albo szablonem
- Regulamin, zasady dotyczące zgłoszeń