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.

Meu projeto é um exemplo de como utilizar o github.

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.

Meu projeto ajuda estudantes inteli a configurarem seus githubs.

May the force be with you!

🛠 Estrutura de pastas

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

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.

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

Android:

Faça o Download do JOGO.apk no seu celular. Execute o APK e siga as instruções de seu telefone.

Coloque código do prompt de comnando se for necessário

Windows:

Não há instalação! Apenas executável! Encontre o JOGO.exe na pasta executáveis e execute-o como qualquer outro programa.

Coloque código do prompt de comnando se for necessário

HTML:

Não há instalação! Encontre o index.html na pasta executáveis e execute-o como uma página WEB (através de algum browser).

📈 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.

Este modelo pode ser copiado e utilizado à vontade.

Através da cópia/clone/ download do repositório, altere os dados do readme.md e carregue os arquivos de seu projeto.

💻 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.

Para abrir este projeto você necessita das seguintes ferramentas:

-GODOT

make install
npm test
Coloque código do prompt de comnando se for necessário

🗃 Histórico de lançamentos

A cada atualização os detalhes devem ser lançados aqui.

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

📋 Licença/License

MODELO GIT INTELI by INTELI, VICTOR BRUNO ALEXANDER ROSETTI DE QUIROZ is licensed under Attribution 4.0 International

🎓 Referências

Aqui estão as referências usadas no projeto.

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