diff --git a/README.adoc b/README.adoc index eb20611..0582a7e 100644 --- a/README.adoc +++ b/README.adoc @@ -1,9 +1,10 @@ = Reference-pt Referência-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 tradução da documentação para Português está em progresso e pode ser encontrada nessa https://reference.arduino.cc/reference/pt/[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 https://raw.githubusercontent.com/arduino/reference-en/master/AsciiDoc_sample/AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary.adoc[`reference-en/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 https://reference.arduino.cc/reference/pt/asciidoc_sample/asciidoc_dictionary/asciidoc_template-dictionary/[aqui]. @@ -13,7 +14,7 @@ Se você quer contribuir para a documentação de referência da linguagem ou ed * Use https://raw.githubusercontent.com/arduino/reference-en/master/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Single_Entity.adoc[`AsciiDoc_Template-Single_Entity.adoc`] (renderizado https://reference.arduino.cc/reference/pt/asciidoc_sample/reference_terms/asciidoc_template-single_entity/[aqui]) para termos como link:http://arduino.cc/en/Reference/AnalogWrite[analogWrite]. * Use https://raw.githubusercontent.com/arduino/reference-en/master/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Parent_Of_Entities.adoc[`AsciiDoc_Template-Parent_Of_Entities.adoc`] (renderizado https://reference.arduino.cc/reference/pt/asciidoc_sample/reference_terms/asciidoc_template-parent_of_entities/[aqui]) para grupos de funções como link:http://arduino.cc/en/Reference/Serial[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 (Ver seção Ver Também). +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. @@ -53,4 +54,4 @@ reference-pt ---- -Dentro da pasta Language, a arvore de arquivos segue a mesma estrutura que nolink:http://arduino.cc/en/Reference/HomePage[Página da Referência do Arduino] +Dentro da pasta Language, a arvore de arquivos segue a mesma estrutura que no link: http://arduino.cc/en/Reference/HomePage[Página antiga da Referência do Arduino (Em Inglês)]