Open Source Ecosystems

= Reference-pt

Reference-pt o repositrio da documentao de referncia para a sintaxe da linguagem Arduino em Portugus. Todos os arquivos da referncia devem estar no formato AsciiDoc. Obrigado por se interessar em contribuir para a documentao de referncia, isso ajuda bastante toda a comunidade Arduino.

A documentao traduzida em Portugus pode ser encontrada nessa https://www.arduino.cc/reference/pt/[Pgina]

== Criao e Edio de Contedo Se voc quer contribuir com um novo contedo, crie um novo arquivo (com qualquer editor de texto ou cdigo) e salve-o como um arquivo formato AsciiDoc (extenso ".adoc"). No use parnteses ou qualquer outro caractere especial no nome do arquivo. No link https://raw.githubusercontent.com/arduino/reference-pt/master/AsciiDoc_sample/AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary.adoc[`reference-pt/AsciiDoc_sample/AsciiDoc_Dictionary`] voc vai encontrar uma viso geral da sintaxe AsciiDoc. Isso inclui ttulos, texto, links, imagens, tabelas, cdigo e vrios embeds (vdeo, slideshow, udio e cdigo). Voc pode ver esse exemplo renderizado https://www.arduino.cc/reference/pt/asciidoc_sample/asciidoc_dictionary/asciidoc_template-dictionary/[aqui].

Se voc quer contribuir para a documentao de referncia da linguagem ou editar um contedo existente, h dois templates disponveis em reference-pt/AsciiDoc_sample/Reference_Terms:

Por favor note que todo arquivo da referncia deve incluir pelo menos uma descrio, algum cdigo de exemplo, e links para outras informaes relevantes (na seo Ver Tambm).

Se voc precisar adicionar imagens no arquivo Asciidoc, por favor crie uma pasta chamada "attachments" na mesma pasta em que se encontra o arquivo Asciidoc. Imagens podem ser salvas em formato SVG ou PNG, de tamanho mximo 200KB.

== Contribuir com Contedo no Github Se ainda no familiarizado com Git, voc pode contribuir diretamente pelo Github pela sua interface online. Ns criamos um pequeno tutorial para explicar como, https://create.arduino.cc/projecthub/Arduino_Genuino/contribute-to-the-arduino-reference-af7c37[Confira!]

link:https://help.github.com/articles/editing-files-in-another-user-s-repository/[Voc pode tambm seguir esse tutorial] (escrito pela equipe do Github) para aprender a editar um arquivo .adoc e propor equipe Arduino uma atualizao do arquivo. Quando sugerir uma atualizao, por favor siga as recomendaes descritas nos arquivos template da referncia do Arduino.

== Submeter um Pull request Ficamos felizes que voc tenha interesse em contribuir para a documentao de referncia, essa a melhor forma de ajudar a comunidade Arduino!

Se sua contribuio est adicionando ou modificando cdigo existente ou descries completas, por favor sempre consulte se h issues abertos ou abra um novo issue antes de contribuir.

=== Estrutura de Diretrios
[source]

reference-pt 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

Dentro da pasta Language, a arvore de arquivos segue a mesma estrutura que no link: https://www.arduino.cc/reference/pt[Pgina da Referncia do Arduino]

=== Licena

Por favor note que sua contribuio para a documentao de referncia licenciada sob a licena Creative Commons Attribution-Share Alike 3.0. Veja https://creativecommons.org/licenses/by-sa/3.0/

image:https://i.creativecommons.org/l/by-sa/3.0/88x31.png[Creative Commons License, title="Creative Commons License"] Este trabalho est licenceado sob a licena: https://creativecommons.org/licenses/by-sa/3.0/deed.pt[Creative Commons Attribution-ShareAlike 3.0 Unported].