Esse repositório é um modelo (template) para a criação de repositórios do projeto RepoAI. Ao mesmo tempo, ele também é um repositório que demonstra como participar do projeto e produzir outros repositórios :D
- Estilo Visual do Repositório
- Repositório em Construção
- Pré-Requisitos e Instalações Necessárias
- Licença 📝
Aqui você deve descrever brevemente a estrutura do repositório
RepoAI/
└── seu_repositorio/
├── content/
│ ├── imagens
│ └── outros
├── code/
| ├── dados
| └── implementação
├── README.md
└── license
Queremos que todos os repositórios publicados sigam o mesmo estilo visual e estrutura, proporcionando assim uma experiência de sinergia aos visitantes. Para isso recomendamos os seguintes elementos visuais:
- Adicione um banner temático no seu repositório. Use o formato de capa para redes sociais. Por exemplo, recomendamos utilizar os templates disponíveis no Canva. Seja criativo!
- Utilize seções e subseções seguindo o mesmo estilo desse template, respeitando fontes e tamanhos.
- Logo ao inicio do arquivo, adicione índices dos conteúdos, e a estrutura de pastas do repositório. Após, apresente uma seção de introdução conceitual sobre a técnica escolhida (use quantas subseções desejar), seja didático usando imagens e diagramas. Depois, adicione uma seção para apresentar a implementação realizada (use quantas subseções desejar), abordando de forma didática o código e dominio de aplicação. Adicione trechos de código, videos curtos, imagens e explicações pontuais na construção do documento. Por último, mantenha uma seção sobre vocês, e, muito importante, a licença indicada.
- Siga a estrutura de pastas indicadas nesse template.
Se você está desenvolvendo o repositório em grupos, ou mesmo está aberto a contribuições, você pode abrir uma lista simples de tarefas nas seções iniciais, para organizar as tarefas:
- Tarefa 1
- Tarefa 2
- Tarefa 3
- Tarefa 4
- Tarefa 5
Faça uma seção de pré-requisitos e instalações necessárias para a execução do tutorial apresentado junto ao repositório. Por exemplo:
Antes de começar, verifique se você atendeu aos seguintes requisitos:
- Você instalou a versão mais recente de
<linguagem / dependência / requeridos> - Você tem uma máquina
<Windows / Linux / Mac>. Indique qual sistema operacional é compatível / não compatível. - Você leu
<guia / link / documentação_relacionada_ao_projeto>.
Para instalar o , siga estas etapas:
Linux e macOS:
<comando_de_instalação>
Windows:
<comando_de_instalação>
Você pode fazer uso de seções escondidas, por exemplo, para exibir trechos de código básico que você acredita que nem todos os leitores terão a necessidade de ver. São elementos perfeitos para esse tipo de conteúdo, ou seja, que é opcional para leitores que já possuem algum background sobre o assunto do repositório. Exemplo:
Exemplo de Seção Escondida
Pode conter texto, imagens, blocos, código (essensialmente qualquer coisa)
print("Hello World").Você pode usar alertas para enfatizar algum aspecto em seu tutorial:
Note
Instruções importantes que os usuários devem conhecer, mesmo ao ler rapidamente o conteúdo.
Tip
Dicas úteis para fazer as coisas de forma melhor ou mais fácil.
Important
Informações essenciais que os usuários precisam saber para alcançar seu objetivo.
Warning
Informações urgentes que exigem a atenção imediata dos usuários para evitar problemas.
Caution
Alertas sobre os riscos ou possíveis consequências negativas de certas ações.
Você pode criar diagramas sem a necessidade de ferramentas externas. Por exemplo, abaixo é apresentado o diagrama de fluxo de submissão de projetos do repositório:
flowchart TB
subgraph Equipe
a1-->|Aprova e Cria|a2[Sub Repositório]
a3-->|avalia|a4[Avaliação]
a4-->|aceita|a5[Publicado!]
end
subgraph Você
b1(Interesse)-->|define|b2(Tema)
b3-->|fork|b4(Repositório)
b4-->|cria|b5(Conteúdo)
b5-->|solicita|a3[Merge]
end
b2-->|submete|a1[Proposta]
a2-->|indica|b3(Pastas)
a4-->|solicita correções|b4
Nesse link você encontra a documentação para criação de digramas.
No GitHub apenas são permitidos incorporações de GIF's e imagens no markdown. Vídeos são dispiníveis apenas por links redirecionados para sites externos ou download de vídeos salvos no projeto.
Para adicionar um GIF, utilize a estrutura abaixo
Para incorporar vídeos em plataformas que suportam vídeos incorporados(como o vscode), você pode utilizar a seguinte estrutura:
<iframe width="560" height="315" src="https://www.youtube.com/embed/VIDEO_ID" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Ou para inserir vídeo local, pode seguir essa estrutura:
<video width="600" controls>
<source src="video.mp4" type="video/mp4">
</video>
link para video local: Vídeo
[video-local](video.mp4)Link para vídeo online: Youtube
[nome-youtube](https://www.youtube.com/video)
[](https://www.youtube.com/video)Você pode listar todos os contribuidores do seu projeto. Adicione a si mesmo.
 Matheus Lima |
 Alison R. Panisson |
|---|
Ao final edite o arquivo de licença, atualizando o ano e seu nome, depois adicione uma breve descrição de que seu projeto está sobre a licença CC-BY, por exemplo:
"Esse projeto está sob licença CC-BY 4.0."
Veja o arquivo Licença para mais detalhes.