mirror of
https://github.com/kylelobo/The-Documentation-Compendium.git
synced 2025-09-03 01:52:42 +02:00
Translate 'Standard.md'
This commit is contained in:
@@ -0,0 +1,86 @@
|
||||
<p align="center">
|
||||
<a href="" rel="noopener">
|
||||
<img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Logo do Projeto"></a>
|
||||
</p>
|
||||
|
||||
<h3 align="center">Título do Projeto</h3>
|
||||
|
||||
<div align="center">
|
||||
|
||||
[]()
|
||||
[](https://github.com/kylelobo/The-Documentation-Compendium/issues)
|
||||
[](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
|
||||
[](/LICENSE)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<p align="center"> Descreva o seu projeto em algumas linhas.
|
||||
<br>
|
||||
</p>
|
||||
|
||||
## 📝 Índice
|
||||
+ [Sobre](#sobre)
|
||||
+ [Primeiros Passos](#primeiros_passos)
|
||||
+ [Realizando o Deploying](#deployment)
|
||||
+ [Uso](#uso)
|
||||
+ [Feito Com](#feito_com)
|
||||
+ [TODO](../TODO.md)
|
||||
+ [Contribuição](../CONTRIBUTING.md)
|
||||
+ [Autores](#autores)
|
||||
+ [Agradecimentos](#agradecimentos)
|
||||
|
||||
## 🧐 Sobre <a name = "sobre"></a>
|
||||
Escreva entre 1-2 parágrafos uma descriçāo com o propósito do seu projeto.
|
||||
|
||||
## 🏁 Primeiros Passos <a name = "primeiros_passos"></a>
|
||||
Estas intruçōes te darão uma cópia funcional do projeto na sua máquina local para desenvolvimento e testes. Veja [deployment](#deployment) para uma descrição de como realizar o deployment desse projeto online.
|
||||
|
||||
### Pré-requisitos
|
||||
|
||||
Descreva o que é necessário para instalar este software e como instalá-lo.
|
||||
|
||||
```
|
||||
Cite exemplos
|
||||
```
|
||||
|
||||
### Instalação
|
||||
|
||||
Passo-a-passo com exemplos que reproduzam um estágio de desenvolvimento funcional.
|
||||
|
||||
Descreva o passo a ser tomado
|
||||
|
||||
```
|
||||
Dê um exemplo
|
||||
```
|
||||
|
||||
Repita
|
||||
|
||||
```
|
||||
Até terminar
|
||||
```
|
||||
|
||||
Finalize com um exemplos de como os dados são processados ou uma pequena demonstração.
|
||||
|
||||
## 🎈 Uso <a name="uso"></a>
|
||||
Descreva como utilizar seu app ou sistema.
|
||||
|
||||
## 🚀 Realizando o Deploying <a name = "deployment"></a>
|
||||
Descreva como realizar o deployment de seu projeto.
|
||||
|
||||
## ⛏️ Contruído Usando <a name = "construido_usando"></a>
|
||||
- [MongoDB](https://www.mongodb.com/) - Database
|
||||
- [Express](https://expressjs.com/) - Server Framework
|
||||
- [VueJs](https://vuejs.org/) - Web Framework
|
||||
- [NodeJs](https://nodejs.org/en/) - Server Environment
|
||||
|
||||
## ✍️ Authors <a name = "authors"></a>
|
||||
- [@kylelobo](https://github.com/kylelobo) - Ideia & Trabalho inicial
|
||||
|
||||
Confira também a lista de [contribuidores](https://github.com/kylelobo/The-Documentation-Compendium/contributors) que participaram nesse projeto.
|
||||
|
||||
## 🎉 Agradecimentos <a name = "agradecimentos"></a>
|
||||
+ Agradecimentos a terceiros, autores ou não de código utilizado nesse projeto.
|
||||
+ Inpiraçōes
|
||||
+ Referêcias
|
||||
|
Reference in New Issue
Block a user