isabella232 / reference-pt

Portuguese version of the Arduino Reference

Reference-pt

Reference-pt é o repositório da documentação de referência para a sintaxe da linguagem Arduino em Português. Todos os arquivos da referência devem estar no formato AsciiDoc. Obrigado por se interessar em contribuir para a documentação de referência, isso ajuda bastante toda a comunidade Arduino.

A documentação traduzida em Português pode ser encontrada nessa Página

Criação e Edição de Conteúdo

Se você quer contribuir com um novo conteúdo, crie um novo arquivo (com qualquer editor de texto ou código) e salve-o como um arquivo formato AsciiDoc (extensão ".adoc"). Não use parênteses ou qualquer outro caractere especial no nome do arquivo. No link reference-pt/AsciiDoc_sample/AsciiDoc_Dictionary você vai encontrar uma visão geral da sintaxe AsciiDoc. Isso inclui títulos, texto, links, imagens, tabelas, código e vários embeds (vídeo, slideshow, áudio e código). Você pode ver esse exemplo renderizado aqui.

Se você quer contribuir para a documentação de referência da linguagem ou editar um conteúdo existente, há dois templates disponíveis em reference-pt/AsciiDoc_sample/Reference_Terms:

• Use AsciiDoc_Template-Single_Entity.adoc (renderizado aqui) para termos como analogWrite.

• Use AsciiDoc_Template-Parent_Of_Entities.adoc (renderizado aqui) para grupos de funções como Serial.

Por favor note que todo arquivo da referência deve incluir pelo menos uma descrição, algum código de exemplo, e links para outras informações relevantes (na seção Ver Também).

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 máximo 200KB.

Contribuir com Conteúdo no Github

Se ainda não é familiarizado com Git, você pode contribuir diretamente pelo Github pela sua interface online. Nós criamos um pequeno tutorial para explicar como, Confira!

Você pode também seguir esse tutorial (escrito pela equipe do Github) para aprender a editar um arquivo .adoc e propor à equipe Arduino uma atualização do arquivo. Quando sugerir uma atualização, por favor siga as recomendações descritas nos arquivos template da referência do Arduino.

Submeter um Pull request

Ficamos felizes que você tenha interesse em contribuir para a documentação de referência, essa é a melhor forma de ajudar a comunidade Arduino!

Se sua contribuição está adicionando ou modificando código existente ou descrições completas, por favor sempre consulte se há issues abertos ou abra um novo issue antes de contribuir.

Estrutura de Diretórios

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: Página da Referência do Arduino

Licença

Por favor note que sua contribuição para a documentação de referência é licenciada sob a licença Creative Commons Attribution-Share Alike 3.0. Veja https://creativecommons.org/licenses/by-sa/3.0/

Este trabalho está licenceado sob a licença: Creative Commons Attribution-ShareAlike 3.0 Unported.