diff --git a/DOC.md b/DOC.md new file mode 100644 index 0000000..55b81c0 --- /dev/null +++ b/DOC.md @@ -0,0 +1,34 @@ +# Nome do Projeto + +> 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 + +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. + +[Ir para o índice](#Índice) + +### Instalação +Passo a passo para instalar a aplicação! Exemplo: +```sh +npm install --save +``` +[Ir para o índice](#Índice) diff --git a/README.md b/README.md index 98259db..087cb7c 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,17 +43,21 @@ 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) -## 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! +**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. -## Como contribuir +## 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'`)