Reference-pl

Reference-pl to repozytorium polskiej dokumentacji języka programowania Arduino. Wszystkie pliki niniejszej Dokumentacji są w formacie AsciiDoc.

Dziękujemy, że poświęcasz czas na pracę przy zawartości ninieszego opracowania. Jest to naprawdę pomocne dla całej społeczności Arduino. Jeśli chcesz dowiedzieć się więcej o tym, jak możesz przyczynić się do rozwoju tego projektu, sprawdź samouczek krok po kroku.

Tworzenie i edycja treści

Jeśli chcesz dodać nową treść, utwórz nowy plik (dowolnym edytorem tekstu lub edytorem kodu źródłowego) i zapisz go jako .adoc. Nie używaj nawiasów ani żadnych znaków specjalnych w nazwie pliku. Pod adresem reference-pl/AsciiDoc_sample/AsciiDoc_Dictionary znajdziesz przegląd składni AsciiDoc. Obejmuje to tytuły, napisy, łącza, obrazy, tabele, kod programów i różne materiały osadzane (wideo, pokazy slajdów, dźwięk i kod). Jak wygląda efekt końcowy, możesz zobaczyć tutaj.

Jeśli chcesz dodać coś od siebie do Dokumentacji Języka lub redagować już istniejącą treść, to pod adresem: reference-pl/AsciiDoc_sample/Reference_Terms możesz znaleźć dwa szablony:

• Użyj AsciiDoc_Template-Single_Entity.adoc (pokazane tutaj) dla pojęć takich jak analogWrite.

• Użyj AsciiDoc_Template-Parent_Of_Entities.adoc (pokazane tutaj) dla grup funkcji takich jak Serial.

Pamiętaj, że każdy plik Dokumentacji powinien zawierać co najmniej opis, jakiś przykładowy kod oraz łącza do innych istotnych informacji (sekcja Zobacz także).

Jeśli chcesz dodać obrazy do Asciidoc, utwórz folder o nazwie attachments w tym samym katalogu co plik Asciidoc. Obrazy możesz zapisywać w formacie SVG i PNG, a ich maksymalny rozmiar to 200 kB.

Przekazywanie treści na Github

Jeśli nie umiesz posługiwać się programem Git, to możesz dodawać treści bezpośrednio na Github za pośrednictwem jego strony www. Przygotowaliśmy krótki samouczek, aby pokazać, jak to zrobić, SPRAWDŹ TO!

Możesz także prześledzić ten przewodnik (napisany przez zespół Github) aby dowiedzieć się, jak edytować plik .adoc i zaproponować zespołowi Arduino zmianę zawartości pliku. Sugerując zmianę, postępuj zgodnie z wytycznymi opisanymi w szablonach plików.

Przesyłanie żądania ściągnięcia

Cieszymy się, że chcesz przyczynić się do powstawania Dokumentacji języka Arduino: to najlepszy sposób, aby pomóc społeczności.

Twój wkład polega na dodawaniu lub modyfikowaniu istniejącego kodu lub całych plików. Prosimy cię, abyś zawsze odnosił się do bieżącego wydania lub pobierał aktualny materiał przed przesłaniem własnego.

Struktura folderów

reference-pl
├─ AsciiDoc_sample
│   ├── AsciiDoc_Dictionary
│   │   ├── AsciiDoc_Template-Dictionary.adoc
│   │   └── attachments
│   └── Reference_Terms
│       ├── AsciiDoc_Template-Parent_Of_Entities.adoc
│       ├── AsciiDoc_Template-Single_Entity.adoc
│       └── attachments
├── Language
│   ├── Functions
│   ├── Structure
│   └── Variables
├── LICENCE.md
└── README.adoc

W folderze Language drzewo plików ma taką samą strukturę jak w odnośniku: https://www.arduino.cc/reference/pl [strona Dokumentacji Arduino]

Licencja

Pamiętaj, że twój wkład w Dokumentację Arduino jest licencjonowany na licencji Creative Commons Uznanie autorstwa - Na tych samych warunkach 3.0. Zobatrz https://creativecommons.org/licenses/by-sa/3.0/

Ta praca jest licencjonowana na zasadach Creative Commons Attribution-ShareAlike 3.0 Unported License.