Como escrever um README.md 在 Github 上引起轰动

2025-06-07

Como escrever um README.md 在 Github 上引起轰动

开发一个新的项目，通过 Git 应用程序进行各种更改，并在社区中使用 Github。

当我们完成任务时，我们将开始拍摄纪录片或项目！ README.md 中没有任何内容。

噢，没有

这篇文章的主题

我的自述文件是什么

这是 HTML 或 Markdown 标签部分的基本文本内容。使用 HTML 来集中化元素的效果是很重要的。您可以使用这些标签来创建文档。这是劳尔·埃斯特维斯 (Raul Esteves) 所推荐的最佳武器。

因为使用

可以使用文档形式来访问您的项目，并以方便地访问 Github 并以更快的速度访问您的产品。

您可以在 README.md 中找到适合每个人的项目证书，如果您想获得更多压缩信息，请下载以下内容：

自述文件结构

  • 标题
  • 地位
  • 目录
  • 描述
  • 布局或部署应用程序
  • 先决条件
  • 安装依赖和库
  • 如何启动应用程序
  • 睾丸根部
  • 数据库
  • 问题解决方案
  • 贡献者
  • 塔雷法斯·安·阿贝托
  • 许可证

最初的内容是通过文档的方式进行的，可以通过以下方式进行：

项目名称和描述：

Coloque o nome do seu projeto。示例：



# Titulo 
ou
<h1 align="center"> Titulo </h1>
Enter fullscreen mode Exit fullscreen mode

以下描述如下：



## Descrição do Projeto
<p align="justify"> Escrever descrição, que ficará com texto justificado </p>
Enter fullscreen mode Exit fullscreen mode

标签aligné usada para alinhar os elementos e 假设离开por padrão。

标题描述

请注意，本项目中的艺术作品包括替代品或标题。 README.md 可以作为可选的补充

如何使用徽章

徽章服务于证书或项目计划的状态、执照、语言、睾丸等。Para saber 可以访问文档。

请使用shields.oi网站内的podemos 。可能会遇到各种各样的模型，您可以将其个性化。

Podemos fazer isso a partir de uma URL como esta:



https://img.shields.io/static/v1?label=<LABEL>&message=<MESSAGE>&color=<COLOR>&style=<STYLE>&logo=<LOGO>
Enter fullscreen mode Exit fullscreen mode

Onde cada 参数意义：

  • 标签：田野里的文字
  • 直接在营地留言
  • COLOR cor do Campo direito（作为 opções podem ser encontradas no site）
  • 徽章内部的样式。 Podemos ter：塑料、扁平、徽章、社交或扁平方形。
  • LOGO野营标志

例如，您可以了解以下参数：

  • 标签como react
  • MESSAGE como 框架
  • 颜色：蓝色
  • 风格与徽章相似
  • REACT 的LOGO

Podemos colocar ele no README assim：



<img src="https://img.shields.io/static/v1?label=react&message=framework&color=blue&style=for-the-badge&logo=REACT"/>
Enter fullscreen mode Exit fullscreen mode

ou ainda：



![Badge](https://img.shields.io/static/v1?label=react&message=framework&color=blue&style=for-the-badge&logo=REACT)
Enter fullscreen mode Exit fullscreen mode

E查拉姆！ Temos um徽章个性化

盾牌的神奇之处在于将项目的 URL 复制到 github 上，并将其放置在公共站点上。接下来，您可以在 acordo com 或 teu 存储库中个性化徽章：

徽章

埃斯克雷瓦作为一个平台的原则

Seria bacana 列表作为应用程序的主要功能，提供列表的一部分，以方便您使用算法：



### Listas não ordenadas
- Cadastro de conta com Google
    - Captura de avatar a partir do login ou registro com google

### Usando um task list, marcando tarefa como completada ou não  

- [X] Cadastro de conta com Google
- [ ] Cadastro de conta com Google

### Lista ordenada
1. Listagem ordenada
Enter fullscreen mode Exit fullscreen mode

职能清单

表情符号

标题和列表可能包含多种表情符号，以代表主题。可能会遇到各种嵌套存储库。对于我们，请复制标签名称并使用 README.md 示例：



## O que a plataforma é capaz de fazer :checkered_flag:

:trophy: Gerar PDF do certificado com as informações preenchidas no formulário para cada participantes para envio de e-mail 

:trophy: Check-list de participantes, permitindo selecionar quem irá receber os certificados 

:trophy: Permite que o organizador do evento escreva sua assinatura digital dentro da plataforma
Enter fullscreen mode Exit fullscreen mode

结果是这样的：

emojs 功能

项目状态

该项目是在开发或完成后完成的，因此可以为您提供帮助或工作。



> Status do Projeto: Concluido :heavy_check_mark:

> Status do Projeto: Em desenvolvimento :warning:
Enter fullscreen mode Exit fullscreen mode

地位

部署应用程序？

您可以使用Netlify或其他平台来允许使用该应用程序，以作为其项目的一部分，并在设备上进行工作，以实现快速和太平洋。 Se tiver, coloque na documentação:



## Deploy da Aplicação com Netlify: :dash:

/* Aqui estamos usando a tag Quotes do markdown*/

> https://certificates-for-everyone-womakerscode.netlify.app/
Enter fullscreen mode Exit fullscreen mode

部署

Poxa，mas meu projeto ainda não está no ar，e agora？

Já dizia aquele ditado：“Quem não tem cão caça com gato”。 Aqui é a mesma coisa, coloque prints do layout do projeto (no caso de uma aplicação frontend ), assim o Visitante já poderá ter uma imagem do que você fez.

Beleza，mas como eu coloco imagens？

存在法律上的限制，其功能如下：

  1. Abra uma 问题
  2. 印西拉乌玛图像
  3. 嗯链接como este será gerado： ![certificado](https://user-images.githubusercontent.com/46378210/80869186-51d1fd00-8c75-11ea-93d3-25485501aa43.png)
  4. 复制 README.md 和 tcharam！图像是 irá aparecer！

更安全的方法是：

  1. Suba no seu repositório a imagem desejada。 Ela ficará junto com os outros arquivos de código。
  2. 访问图像并复制 URL，然后使用以下命令：https://github.com/Diana-ops/womakerscodeReact/blob/master/api-cep/src/assets/background.png
  3. 使用 uma tag imge insira o link emsrc

如果您想在网络上捕获图像，请使用 URL 作为最重要的路径，否则无法安全地获取图像。

E se alguém quiser rodar or projeto na maquina？

重要的文档主题，以及开源代码的主要内容。 O primeiro passo é escrever os pre-requesitos que ele precisa para rodar, como o yarn, npm, gem, bundle, 等等。

在开发人员的最后一步中，我们将完成安装和执行意大利面的所有操作。

运行应用程序

依赖项和技术

Sobre colocar as linguagens eu já antecipo: dependente .我们将在 Github 上将其作为 arquivos 的语言，而不是直接的拓扑。

语言学家

夏天到了，就不需要重新清洗了。 Mas caso tenha usado alguma lib extra como React Routes、React PDF、Antdesign 和 bacana colocar。

如果您需要深入了解安装程序的相关性，请注意以下事项：作为安装程序的说明，请参阅有关专有文档的说明。yarn installbundle

您可以使用以下格式的链接：



## Linguagens e libs utilizadas :books:

- [React PDF](https://react-pdf.org/): versão xx.xxx
Enter fullscreen mode Exit fullscreen mode

库

请访问所有列表，作为依赖于文档的链接。 Se for o caso, indique a versão necessária para rodar o projeto.

爸爸，爸爸，还有爸爸

您可以使用后端应用程序或JSON 格式来编写文档。我们将组织各种其他信息。作为专栏，分开的佩拉斯巴拉斯和标题主要做连续的分开的佩洛斯特拉科斯。



### Participante: 
|name|email|present|receiveCertificate|course|
| -------- | -------- | -------- |-------- | -------- |
|Chaiana Hermes|chaiana_hermes@yahoo.com.br|true|false|Bootcamp React|
Enter fullscreen mode Exit fullscreen mode

json

睾丸如何长？

使用项目的睾丸实践（caso nunca tenha feito, comece já）和独立的语言，以确保在任何时候都可以执行和重要的纪录片。示例：



/*Para projetos com React*/
$ npm test

/*Para projetos com Rails*/
$ rspec
Enter fullscreen mode Exit fullscreen mode

有空吗或者项目？

Pode Ser que ainda faltem algumas funcionalidades para serem Implementadas or refatorações em algumaparte do codigo. Aqui é o momento de listar quais tarefas estão abertas em issues or no próprio README.md caso esteja aberto para receber contribuições e ajuda.

朋友们都不知道

可以通过团队或接收拉取请求来提交项目，以贡献 destaque-os。 Uma coisa bem bacana aqui é milsturar imagens com tabelas：



[<img src="https://avatars2.githubusercontent.com/u/46378210?s=400&u=071f7791bb03f8e102d835bdb9c2f0d3d24e8a34&v=" width=115 > <br> <sub> Diana Regina </sub>](https://github.com/Diana-ops) |
| :---: |
Enter fullscreen mode Exit fullscreen mode

康夫索？冷静下来。

  • 德特罗德|| temos uma 标签 html <img>、定义或链接eo tamanho da imagem com src和宽度。 Aqui foi inserido o avatar do dev.

  • 放置一个标签<br>，然后将其与图像中的 colocando 元素进行比较。

  • Dentro de <sub>colocamos o nome dele。

  • Em seguida, juntamos a imagem eo nome dentro de [] seguido do link do github em ()

  • 最后，组织“micro tabela”的元素，obtendo como resultado algo parecido com：

Para inserir mais devs, basta adicionais mais colunas。

阿米吉尼亚斯

解决应用期间的问题？文件！

在执行项目期间不可避免地会出现错误，这是一个很严重的问题，在没有stackoverflow和问题的情况下会导致回复。打开解析器，但在该时间点，解析器不存在。

Não passe mais por isso！解决所有问题，提出错误和最常见的解决方案，并通过生活和项目结束开发。Éuma forma forma sensacional de contribuir pra comunidade。

Claro，您可以在 README.md 中进行详细说明：



### Resolvendo problemas

Veja alguns problemas que surgiram no desenvolvimento deste projeto e como os resolvi em [issues](https://github.com/Diana-ops/treina-dev-turma-3/issues)
Enter fullscreen mode Exit fullscreen mode

问题

Ei，posso copiar o seu projeto？

使用许可证的算法、直接操作和限制是很重要的。

可以使用 MIT 的许可证，允许使用、修改和分发项目，并保留责任。

插入，访问

  1. 洞察 > 社区
  2. 点击add许可
  3. Uma PR Será aberta e ao aceita-la uma nova Branch Será criada
  4. Agora 是 MIT 的主题

执照

用蜂蜜采摘

乌法，主要工作人员编写了一个文档，其中包含了一些连续的列表（como se fosse um sumário），没有任何 README.md 可以直接访问该主题。



### Tabela de Conteúdos
   * [Nome do tópico visivel](#nome-do-tópico)

### Nome do Tópico
Enter fullscreen mode Exit fullscreen mode

⚠️ 参考或替代主题的小标题 ⚠️ 主题替换内容，询问和感叹号，没有问题，没有降价，没有
继续下去。
⚠️ Caso o 主题 acompanhado de um emoji, escreva-o ignorando o simbolo ::

拉多的前缀

我不想看到纪录片的项目终端。佩洛相反！这是一个最初的故事，以飞机和纪录片的节奏进行。

伦布兰多（Lembrando）没有提供任何信息和必要的信息，因此您可以根据自己的项目和主题进行选择。

普雷斯特

请注意，模板中没有包含自述文件的说明。世界的力量❤️

开始时的伏尔塔

文章来源：https://dev.to/reginadiana/como-escrever-um-readme-md-sensacional-no-github-4509
Devto 翻译
PREV
为您的下一个项目提供免费插图
NEXT
使用 Google Lighthouse 提高应用性能