Criar repositório usando este template Preencha as seções do README, e remova comentários como este após a edição.
O README deve conter uma primeira seção abstract, sendo ela um cabeçalho de nível 1 (# Nome do projeto)
Descrição do projeto, objetivos e intenções de uso Deve conter ao final a Badge (imagem horizontal) do H.IAAC e das Metas associadas ao projeto
This project was developed as part of the Cognitive Architectures research line from the Hub for Artificial Intelligence and Cognitive Architectures (H.IAAC) of the State University of Campinas (UNICAMP). See more projects from the group here.
Mantenha apenas as badges das Metas associadas ao projeto (elas podem ser reorganizadas na mesma linha)
As seguintes seções são obrigatórias, devendo começar com um cabeçalho de nível 2 (## Nome da seção), mantendo o nome delas. No caso de nomes condicionais (A / B), é possível manter assim ou escolher apenas um nome (## A / B ou ## A ou ## B)
Caso deseje, pode adicionar outras seções além das obrigatórias (utilize apenas cabeçalhos de nível 2 e maior)
Lista e descrição das pastas e arquivos importantes na raiz do repositório
- <pasta>: <descrição>
Descrição do passo-a-passo para instalação de bibliotecas, softwares e demais ferramentas ncessárias para execução do projeto antes de se clonar o repositório, assim como possíveis requisitos mínimos para o projeto (processador, gpu, compilador, etc).
Passo-a-passo para execução do projeto localmente, assim como parâmetros de configuração aceitos (por exemplo, como trocar o caminho para o arquivo de entrada ou saída). No caso de bibliotecas/API fornecer o link para a documentação do mesmo se disponível.
Forneça o Bibtex para citação do repositório.
Ele deve ser um bloco de código do tipo bibtex (```bibtex CITAÇÃO ```), contendo uma citação do tipo
@software, para o repositório. Existe um script para gerar a citação automaticamente (veja ao final deste arquivo).A primeira citação deve ser ao código do repositório. Citação a outras produções relacionadas podem vir em seguida.
@software{
}Lista ordenada por data das pessoas que desenvolveram algo neste repositório. Deve ter ao menos 1 autor. Inclua todas as pessoas envolvidas no projeto e desenvolvimento
Você também pode indicar um link para o perfil de algum autor: [Nome do Autor](Link para o Perfil)
- (<ano início>-<ano fim>) <Nome>: <degree>, <instituição>
Agradecimento as intituições de formento. O agradecimento ao MCTI não deve ser alterado.
Project supported by the brazilian Ministry of Science, Technology and Innovations, with resources from Law No. 8,248, of October 23, 1991
Outros arquivos e informações que o repositório precisa ter:
- Preencha a descrição do repositóio
- É necessário um role de admin no repositório para alterar sua descrição. Pessoas com role de owner na organização do GitHub podem alterar os papéis por repositório.
- Na página principal do repositório, na coluna direita, clique na engrenagem ao lado de "About"
- É recomendável também adicionar "topics" aos dados do repositório
- Um arquivo LICENSE contendo a licença do repositório. Recomendamos a licença LGPLv3.
- Converse com seu orientador caso acredite que essa licença não seja adequada.
- Um arquivo CFF contendo as informações sobre como citar o repositório.
- Este arquivo é lido automaticamente por ferramentas como o próprio GitHub ou o Zenodo, que geram automaticamente as citações.
- Existem ferramentas para auxiliar a criação do arquivo, como o CFF Init.
- O script
generate_citation.pypode ser utilizado para preencher o bloco de citação deste README automaticamente:
python -m pip install cffconvert python generate_citation.py- Caso o arquivo tenha a tag
doi: <DOI>, ele será lido automaticamente pelo Index.- Opcionalmente, o repositório pode ser preservado utilizando o Zenodo, que gerará um DOI para ele. Tutorial.
- É necessário um role de admin no repositório para publicar um repositório utilizando o Zenodo. Pessoas com role de owner na organização do GitHub podem alterar os papéis por repositório.