diegodario88/modelo-readme.md

Last active March 4, 2021 11:23

Star (0) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/diegodario88/a42a478df204fdc6ddac62cc8d13ed45.js"></script>
Save diegodario88/a42a478df204fdc6ddac62cc8d13ed45 to your computer and use it in GitHub Desktop.

Download ZIP

Modelo de README

Raw

modelo-readme.md

O arquivo README geralmente segue um formato para orientar imediatamente os desenvolvedores sobre os aspectos mais importantes do projeto.

Aqui vai o nome do Projeto

O nome do projeto é o primeiro item do readme. Comece o documento com essa informação. Dê preferência de ênfase na formatação desse item, ou seja, ele deve ser um título.

Descrição

Segue-se uma descrição do projeto. Uma boa descrição é clara, curta e direta.

Dependências

Liste as dependências que são obrigatórias no projeto. Se possível anexe link para a documentação

Exemplo:

Node.js 10.13 ou maior. Doc's

Configurando e rodando local

Descreva detalhadamente, em passos, como configurar e executar a aplicação.

Exemplo:

Renomeie o arquivo example.env.local para: .env.local
Suba a aplicação rodando: npm run dev

Acesse a Aplicação

http://localhost:3000

Tecnologias

No item de tecnologias usadas é importante colocar links para que seja fácil a identificação da documentação oficial.

Exemplo:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment