From d8f696622726eb262594a5747162a88dbf40ea7a Mon Sep 17 00:00:00 2001 From: Daniel Nunes Date: Fri, 31 Aug 2018 12:52:06 -0300 Subject: [PATCH 1/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 98259db..c0872a7 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ npm test Aqui você pode incluir uma descrição sobre você, sobre suas redes sociais github etc... * [Maintainer Name](https://github.com/maintainer_github) -## Licensa +## Licença [MIT](https://sualicensa.com/license/mit/) Relatar aqui o tipo da licensa na qual o projeto tem ex: MIT, GNU, ou qualquer que seja! From 1d25c3176780bb794883aa5db61491baa98ff3d1 Mon Sep 17 00:00:00 2001 From: Daniel Nunes Date: Sat, 1 Sep 2018 21:18:28 -0300 Subject: [PATCH 2/8] Create DOC.md --- DOC.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 DOC.md diff --git a/DOC.md b/DOC.md new file mode 100644 index 0000000..98cbf32 --- /dev/null +++ b/DOC.md @@ -0,0 +1,26 @@ +# Nome do Projeto + +## Índice +* [Requerimentos](#Requerimentos) + - Subtópicos se necessário +* [Instalação](#Instalação) + - Subtópicos se necessário +* [Uso](#Uso) + - Subtópicos se necessário +* [Contribua](#Contribua) + +### Requerimentos + +Descreva o que a aplicação precisa para funcionar. +* `ionic x.x` +* `lib` não sei das quantas... + +Descrever como uma observação **Obs:** o motivo da utilização de cada `lib` extra do projeto. + +### Instalação +Passo a passo para instalar a aplicação! Exemplo: +```sh + +npm install --save + +``` From ad61a2de26c220ea836b6bff3bf9ee9f4b201349 Mon Sep 17 00:00:00 2001 From: Daniel Nunes Date: Sat, 1 Sep 2018 21:20:05 -0300 Subject: [PATCH 3/8] Update README.md --- README.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c0872a7..a2fe461 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,31 @@ # Nome do Projeto/produto que está realizando + +## Um Screenshot do projeto em funcionamento > Uma pequena descrição sobre o que é o projeto/produto +Você também pode adicionar alguns `badges/states` ao lado de Nome do projeto, por exemplo, os ofertados pelos serviços: ++ [Emoji Cheat Sheet](https://www.webfx.com/tools/emoji-cheat-sheet/) ++ [Travis CI](https://travis-ci.org/) ++ [AppVeyor](http://www.appveyor.com/) ++ [Coveralls](https://coveralls.io/) ++ [Gitter](https://gitter.im/) ++ [Shields.io](http://shields.io/) ++ Others ## Como usar -Um breve guia de como usar o que foi feito +Uma breve descrição de como usar o que foi feito. ### Requerimentos -Descreva o que a aplicação precisa para funcionar -* ionic x.x -* lib não sei das quantas +Descreva o que a aplicação precisa para funcionar. +* `ionic x.x` +* `lib` não sei das quantas... +Descrever como uma observação **Obs:** o motivo da utilização de cada `lib` extra do projeto. ### Instalar -Passo a passo para instalar a aplicação! +Passo a passo para instalar a aplicação! Exemplo: ```sh npm install --save @@ -23,7 +34,7 @@ npm install --save ### Rodar -Descreva aqui como que é o procedimento para rodar a aplicação +Descreva aqui como que é o procedimento para rodar a aplicação. ```sh make install @@ -32,14 +43,19 @@ npm test ## Descrição do(s) autor/autores -Aqui você pode incluir uma descrição sobre você, sobre suas redes sociais github etc... +Aqui você pode incluir uma descrição sobre você, sobre suas redes sociais etc... * [Maintainer Name](https://github.com/maintainer_github) + ## Licença [MIT](https://sualicensa.com/license/mit/) Relatar aqui o tipo da licensa na qual o projeto tem ex: MIT, GNU, ou qualquer que seja! +**Obs:** Caso o projeto seja pequeno e por algum motivo escolha não usar a `wiki`, pode-se fazer uma breve documentação detalhando pontos importantes em um outro arquivo `Readme.md` seguindo o arquivo [DOC.md](https://github.com/nunesdaniel/documentation-templates/blob/master/DOC.md). + +## Comentários +Por favor, abra uma [issue](https://github.com/nunesdaniel/documentation-templates/issues) para suporte. ## Como contribuir From cd90ec65526144578047848fd375ce95cdadc626 Mon Sep 17 00:00:00 2001 From: Daniel Nunes Date: Sat, 20 Oct 2018 13:52:29 -0300 Subject: [PATCH 4/8] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index a2fe461..087cb7c 100644 --- a/README.md +++ b/README.md @@ -52,13 +52,12 @@ Aqui você pode incluir uma descrição sobre você, sobre suas redes sociais et [MIT](https://sualicensa.com/license/mit/) Relatar aqui o tipo da licensa na qual o projeto tem ex: MIT, GNU, ou qualquer que seja! -**Obs:** Caso o projeto seja pequeno e por algum motivo escolha não usar a `wiki`, pode-se fazer uma breve documentação detalhando pontos importantes em um outro arquivo `Readme.md` seguindo o arquivo [DOC.md](https://github.com/nunesdaniel/documentation-templates/blob/master/DOC.md). +**Obs:** Caso o projeto seja pequeno e por algum motivo escolha não usar a `wiki`, pode-se fazer uma breve documentação com outros detalhes de instalação e de uso, complementares a descrição exposta nesse arquivo `Readme.md`, detalhando outros pontos importantes, seguindo o arquivo [DOC.md](https://github.com/nunesdaniel/documentation-templates/blob/master/DOC.md) e ir adicionando itens de acordo com a necessidade. ## Comentários Por favor, abra uma [issue](https://github.com/nunesdaniel/documentation-templates/issues) para suporte. ## Como contribuir - 1. git clone () 2. Crie uma branch (`git checkout -b seunome-alteração`) 3. Faça Commit das alterações (`git commit -am 'adicione um comentario sobre as alterações'`) From 6d6e80fb042d76eb46e147ce257bb2894b10196a Mon Sep 17 00:00:00 2001 From: Daniel Nunes Date: Sat, 20 Oct 2018 14:02:10 -0300 Subject: [PATCH 5/8] Update DOC.md --- DOC.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/DOC.md b/DOC.md index 98cbf32..a516b42 100644 --- a/DOC.md +++ b/DOC.md @@ -1,13 +1,20 @@ # Nome do Projeto -## Índice +> Descrição + +## Índice * [Requerimentos](#Requerimentos) - Subtópicos se necessário * [Instalação](#Instalação) - Subtópicos se necessário * [Uso](#Uso) - Subtópicos se necessário +* [Erros](#Erros) + - Subtópicos se necessário +* [Atualizações](#Atualizações) + - Subtópicos se necessário * [Contribua](#Contribua) + - Subtópicos se necessário ### Requerimentos @@ -17,6 +24,8 @@ Descreva o que a aplicação precisa para funcionar. Descrever como uma observação **Obs:** o motivo da utilização de cada `lib` extra do projeto. +[Ir para o índice](#Índice) + ### Instalação Passo a passo para instalar a aplicação! Exemplo: ```sh @@ -24,3 +33,4 @@ Passo a passo para instalar a aplicação! Exemplo: npm install --save ``` +[Ir para o índice](#Índice) From 7278bd579a12163307f66c543604b8209cb4d54d Mon Sep 17 00:00:00 2001 From: Daniel Nunes Date: Sat, 20 Oct 2018 14:06:08 -0300 Subject: [PATCH 6/8] Update DOC.md --- DOC.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/DOC.md b/DOC.md index a516b42..55b81c0 100644 --- a/DOC.md +++ b/DOC.md @@ -16,7 +16,7 @@ * [Contribua](#Contribua) - Subtópicos se necessário -### Requerimentos +### Requerimentos Descreva o que a aplicação precisa para funcionar. * `ionic x.x` @@ -26,11 +26,9 @@ Descrever como uma observação **Obs:** o motivo da utilização de cada `lib` [Ir para o índice](#Índice) -### Instalação +### Instalação Passo a passo para instalar a aplicação! Exemplo: ```sh - npm install --save - ``` [Ir para o índice](#Índice) From f5a6512e1c9fb5ef1328432d7f9f52ef825fffcf Mon Sep 17 00:00:00 2001 From: Daniel Nunes Date: Sat, 20 Oct 2018 14:07:43 -0300 Subject: [PATCH 7/8] Update DOC.md --- DOC.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/DOC.md b/DOC.md index 55b81c0..bd10f6e 100644 --- a/DOC.md +++ b/DOC.md @@ -3,17 +3,17 @@ > Descrição ## Índice -* [Requerimentos](#Requerimentos) +[Requerimentos](#Requerimentos) - Subtópicos se necessário -* [Instalação](#Instalação) +[Instalação](#Instalação) - Subtópicos se necessário -* [Uso](#Uso) +[Uso](#Uso) - Subtópicos se necessário -* [Erros](#Erros) +[Erros](#Erros) - Subtópicos se necessário -* [Atualizações](#Atualizações) +[Atualizações](#Atualizações) - Subtópicos se necessário -* [Contribua](#Contribua) +[Contribua](#Contribua) - Subtópicos se necessário ### Requerimentos From f00834e6d376d3bc22f86095e6c99d917b2987cf Mon Sep 17 00:00:00 2001 From: Daniel Nunes Date: Sat, 20 Oct 2018 14:08:34 -0300 Subject: [PATCH 8/8] Update DOC.md --- DOC.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/DOC.md b/DOC.md index bd10f6e..55b81c0 100644 --- a/DOC.md +++ b/DOC.md @@ -3,17 +3,17 @@ > Descrição ## Índice -[Requerimentos](#Requerimentos) +* [Requerimentos](#Requerimentos) - Subtópicos se necessário -[Instalação](#Instalação) +* [Instalação](#Instalação) - Subtópicos se necessário -[Uso](#Uso) +* [Uso](#Uso) - Subtópicos se necessário -[Erros](#Erros) +* [Erros](#Erros) - Subtópicos se necessário -[Atualizações](#Atualizações) +* [Atualizações](#Atualizações) - Subtópicos se necessário -[Contribua](#Contribua) +* [Contribua](#Contribua) - Subtópicos se necessário ### Requerimentos