Skip to content

Commit 7ec84cf

Browse files
committed
Translates "Writing a README"
1 parent fe444ae commit 7ec84cf

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

_articles/pt/starting-a-project.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -136,32 +136,32 @@ Quando você cria um projeto do GitHub, é dada a opção de escolher uma licen
136136

137137
Se você possui outros questionamentos e preocupações acerca dos aspectos legais da administração de um projeto open source, [podemos te ajudar](../legal/).
138138

139-
### Writing a README
139+
### Escrevendo um README
140140

141-
READMEs do more than explain how to use your project. They also explain why your project matters, and what your users can do with it.
141+
READMEs fazem mais do que explicar como usar o seu projeto. Eles também explicam porque o seu projeto importa, e o que os seus usuários podem fazer com ele.
142142

143-
In your README, try to answer the following questions:
143+
No seu README, tente responder as seguintes questões:
144144

145-
* What does this project do?
146-
* Why is this project useful?
147-
* How do I get started?
148-
* Where can I get more help, if I need it?
145+
* O que esse projeto faz?
146+
* Por que esse projeto é útil?
147+
* Como começo?
148+
* Onde posso conseguir ajuda, seu eu precisar?
149149

150-
You can use your README to answer other questions, like how you handle contributions, what the goals of the project are, and information about licenses and attribution. If you don't want to accept contributions, or your project is not yet ready for production, write this information down.
150+
Você pode usar o seu README para responder outras questões, por exemplo como você lida com contribuições, quais são os objetivos do projeto e informações sobre licenças e atribuições. Se você não quer aceitar contribuições, ou seu projeto não está pronto para produção, escreva no README essa informação.
151151

152152
<aside markdown="1" class="pquote">
153153
<img src="https://avatars.githubusercontent.com/limedaring?s=180" class="pquote-avatar" alt="avatar">
154-
Better documentation means more users, less support requests, and more contributors. (...) Remember that your readers aren't you. There are people who might come to a project who have completely different experiences.
154+
Uma documentação melhor significa mais usuários, menos requisições de suporte, e mais contribuidores. (...) Lembre-se de que os seus leitores não são você. Há pessoas que chegarão ao projeto com experiências completamente diferentes.
155155
<p markdown="1" class="pquote-credit">
156156
@limedaring, ["Writing So Your Words Are Read (video)"](https://www.youtube.com/watch?v=8LiV759Bje0&list=PLmV2D6sIiX3U03qc-FPXgLFGFkccCEtfv&index=10)
157157
</p>
158158
</aside>
159159

160-
Sometimes, people avoid writing a README because they feel like the project is unfinished, or they don't want contributions. These are all very good reasons to write one.
160+
Algumas vezes, as pessoas evitam escrever um README porque sentem que o projeto não está finalizado, ou não querem contribuições. Essas são todas boas razões para escrever um.
161161

162-
For more inspiration, try using @18F's ["Making READMEs Readable"](https://pages.18f.gov/open-source-guide/making-readmes-readable/) or @PurpleBooth's [README template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2) to write a complete README.
162+
Para mais inspiração, tente usar o ["Making READMEs Readable"](https://pages.18f.gov/open-source-guide/making-readmes-readable/) do @18F ou o [README template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2) do @PurpleBooth para escrever um README completo.
163163

164-
When you include a README file in the root directory, GitHub will automatically display it on the repository homepage.
164+
Quando você inclui um arquivo de README no seu diretório raiz, o GitHub irá automaticamente renderizá-lo na página inicial do projeto.
165165

166166
### Writing your contributing guidelines
167167

0 commit comments

Comments
 (0)