Inteli - Instituto de Tecnologia e Liderança

Nome do Projeto

Nome do Grupo

Integrantes: Goku Sayajin, Saitama One, Ikki de Fenix, Yusuke Urameshi, Roronoa Zoro

Descrição

📜 Descrição curta sobre o que seu projeto faz.

Game by Nick Youngson CC BY-SA 3.0 Pix4free

💡 De um a dois parágrafos sobre o que é seu projeto e o que ele faz.

🛠 Estrutura de pastas

-Raiz
|
|-->documentos
 |-->antigos
 |GDD.docx ou Documentação.docx
|-->executáveis
 |-->windows
 |-->android
 |-->HTML
|-->imagens
|-->src
|readme.md
|license.txt

A pasta raiz contem dois arquivos que devem ser alterados:

README.MD: Arquivo que serve como guia e explicação geral sobre seu projeto. O mesmo que você está lendo agora.

license.txt: Arquivo de licença do projeto, para que qualquer um possa entender até que ponto podem utilizar seu projeto. Aconselhável utilizar a licença Creative Commons Attribution 4.0 International.

Há também 4 pastas que seguem da seguinte forma:

documentos: Aqui estarão todos os documentos do projeto, mas principalmente o GDD (Game Design Document)/Documentação do Sistema. Há uma pasta antigos onde estarão todas as versões antigas da documentação.

executáveis: Aqui estarão todos os executáveis do jogo, prontos para rodar. Há no mínimo 3 pastas, uma para binários Windows, uma para binários android e uma para a Web/HTML

imagens: Algumas imagens do jogo/sistema e logos prontos para serem utilizados e visualizados.

src: Nesta pasta irá todo o código fonte do jogo/sistema, pronto para para ser baixado e modificado.

🛠 Instalação

OS X & Linux:

npm install my-crazy-module --save

Windows:

edit autoexec.bat

📈 Exemplo de uso

Alguns exemplos interessantes e úteis sobre como seu projeto pode ser utilizado.

Adicione blocos de códigos e, se necessário, screenshots.

Para mais exemplos, consulte a Wiki.

💻 Configuração para Desenvolvimento

Descreva como instalar todas as dependências para desenvolvimento e como rodar um test-suite automatizado de algum tipo. Se necessário, faça isso para múltiplas plataformas.

make install
npm test

🗃 Histórico de lançamentos

• 0.2.1
  • MUDANÇA: Atualização de docs (código do módulo permanece inalterado)
• 0.2.0
  • MUDANÇA: Remove setDefaultXYZ()
  • ADD: Adiciona init()
• 0.1.1
  • CONSERTADO: Crash quando chama baz() (Obrigado @NomeDoContribuidorGeneroso!)
• 0.1.0
  • O primeiro lançamento adequado
  • MUDANÇA: Renomeia foo() para bar()
• 0.0.1
  • Trabalho em andamento

📋 Meta

Seu Nome – Portfólio – SeuEmail@exemplo.com

Distribuído sob a licença XYZ. Veja LICENSE para mais informações.

https://github.com/seuUsuario/nomeDoRepositorio

🚀 Contribuição

1. Faça o fork do projeto (https://github.com/seuUsuario/nomeDoRepositorio/fork)
2. Crie uma branch para sua modificação (git checkout -b meu-novo-recurso)
3. Faça o commit (git commit -am 'Adicionando um novo recurso...')
4. Push (git push origin meu-novo-recurso)
5. Crie um novo Pull Request

🎓 Referências

1. https://github.com/iuricode/readme-template
2. https://github.com/gabrieldejesus/readme-model
3. https://creativecommons.org/share-your-work/