LEIA-ME ou te devoro：Como escrever um bom README

戏剧性的标题，我们已经想到了……但我们无法抵抗，也无法摆脱困境。
通过自述文件，您可以在任何地方、任何地点、任何地方贡献自己的力量或使用开源项目来编写文档、声音、元数据、为自己做贡献。

请阅读 READ.ME，这是一个开源项目的初始页面，它是 React、js 的框架，是一个实用的计算工具。

O que é um README 是否重要？

是否有自述文件？我的名字是 LEIAME 的葡萄牙语翻译，这是我的文档文件。马斯，为什么？

O README 是 Markdown (.md) 的一部分，是项目设计说明手册的考虑因素。有关信息，请参阅我们的其他信息，贡献我们的项目，并为您提供帮助。

Você deveria se importar porque esse é o primeiro arquivo que as pessoas vão ler no seu projeto!在 README 中，您可以完成项目，然后在 README 中完成项目。

如何创建 README 文件

直接通过 GitHub

Primeiro vamos 作为技术。自述文件中的格式多种多样。

最初是在 GitHub 上发布的新项目，在文本页面上将其初始化为 com，并添加 README 和原始操作。请参阅 README 中的 caixinha aqui e seu projeto já vai ser criado com ：

您可以从存储库的根目录或 README.md 中获取存储库的详细信息，并在存储库的初始页面上找到相关内容。

O README criado aqui é bem básico, masnese artigo vou ensinar como deixar ele mais completo。

手动创建

如果您使用项目，请阅读自述文件手册，请使用 README.md 名称，而不是项目的根目录，因为您更喜欢（终端、IDE、Pelo GitHub mesmo）。

Na imagem abaixo, você pode ver o um REAME sendo criado dentro da Pasta leiame pelo Terminal do Git

Agora que já temos nosso arquivo criado, vamos editá-lo com os itens necessários？

正在编辑您的 README 文件

阅读 README 内容，了解有关项目的各种信息，并了解更多选项，自述文件的开发时间不长，项目标题和说明、安装和项目介绍、使用情况、贡献内容许可证删除。

Vamos falar sobre cada um desses itens。

标题和描述

就标题而言，我们可以描述可能的情况，将其视为项目主体的对立面。

标题的补充说明： 项目是否可以提供服务？是作为技术应用的嵌套项目吗？我希望您能提供更多关于未来项目的信息。

请参阅 README 中最重要的描述，其中包含有关 essa sessão 的特别内容 <3

科莫安装和罗德或项目

所有项目都适用于所有项目，并且作为安装和本地安装的项目，也是非常重要的。

Aqui você deve include um passo-a-passo detalhado de como instalar or tudo que é necessário para fazer of desenvolvimento rodar sem Problemas.

Como Usar o projeto

Escreva aqui instruções de como usar seu projeto e adicione exemplos de como ele já foi usado (uma ótima dica é pedir para quem já usa o projeto contribuir nessa sessão)。

Aqui é 法律辅助视觉，como prints do projeto funcionando 和 qualquer outra coisa que você 考虑有趣和相关。

贡献者

Projetos Open Source geralmente estão semper aceitando contribuições（esse é，afinal，o apeloprinciple de Open Source），então é bom ter um guia de contribuições。 Se uma pessoa quiser contribuir，o que ela deve fazer？

Apenas dar um Fork e criar uma PR 或 ela precisa criar uma 问题primiro？

你可以直接贡献自己的力量，并从中获得灵感。

执照

您可以在 GitHub 上使用新的存储库，并获得用户许可。

这是一个许可证，可以用于更改、更改、使用和分发。

麻省理工学院的存在变化和小项目的存在。您可以为自己的项目提供巨大的帮助，建议您获得最好的许可，以解决未来的问题

可选物品

阅读 README 后，您会发现它非常有用。

Como itens opcionais temos:

• 详细内容请参阅自述文件，以便于阅读。

• Créditos, (caso você teve ajuda ou se inspirou em algum outro projeto ou pessoa, é semper legal dar crédito a quem merece.

• 徽章是视觉上的，徽章提示是存在的。请访问https://shields.io/，复制徽章设计和附件。您可以使用带有演示资格的项目许可证的徽章，例如：

DESAFIO：Vamos criar um README？

我想知道的是，我们的目标是：使用 GitHub 上的算法进行项目，并阅读 README bonitinho。

请查看欧盟版存储库链接并发表评论！

Você também pode compartilhar nas redes sociais se Preferred, mas poravour mencione esse artigo <3

Obrigada por ler até aqui,

帕奇🥑