Skip to content

Brazilian-Institute-of-Robotics/doogie_documentation

Repository files navigation

Monografia de conclusão de curso

Este repositório contém a monografia do projeto de conclusão de curso TheoPrax dos cursos de Engenharia de Controle e Automação e Engenharia Mecânica apresentada no Centro Universitário SENAI CIMATEC como requisito parcial para obtenção do título de Bacharel em Engenharia bem como os slides da apresentação final e um artigo oriundo do projeto que foi publicado no V SIINTEC International Symposium on Innovation and Technology.

Componentes da equipe:

  • Caio Amaral
  • Élisson Ríller
  • Iure Pinheiro
  • Mateus Meneses

Orientador: Prof. Msc. Marcos Reis

Como usar:

Para a compilação e edição dos arquivos da monografia, recomenda-se o uso do ambiente de gravação integrado para criar documentos LaTeX TeXstudio.

Para instalação deste ambiente, recomenda-se primeiro instalar o TeX Live. Para isso, execute o seguinte comando no seu terminal:

sudo apt-get install texlive-full

Após a instalação do textlive-full, instale o TeXstudio através do seguinte comando:

sudo apt-get install texstudio

Observações: Os comandos foram executados utilizando o terminal da distribuição Ubuntu 16.04. Caso queira utilizar o editor de sua preferência, ignore os passos acima.

Caso possua git instalado na sua máquina, clone o repositório numa pasta de desejo. Caso contrário, faça o download do repositório em formato .zip e descompacte-o.

git clone https://github.com/cimatecmateus/monografia_theoprax_doogie.git

No TeXstudio ou no seu editor de escolha, abra o arquivo tprax_doc_tex.tex e então compile-o para obter uma versão pdf da monografia. Navegue entre os capítulos e seções para editá-los e então recompile novamente o documento para visualizar o resultado da edição.

Contribuição

Algumas dicas:

  • Sempre que forem editar o documento, atualizar seu repositório local para evitar problemas futuros de conflitos

  • A branch master deve ficar sempre com o conteúdo mais atualizado e revisado da monografia. Para atualizá-la, solicite um pull request e adicione um revisor. Quando o pull request for revisado e aprovado, imediatamente exclua a branch em que se estava trabalhando. Essa boa prática evita futuros problemas de conflitos

  • As mensagens de commit devem ser realizadas em português. Como recomendação, utilize as seguintes boas práticas. Isto deixa o histórico de commits mais claro e limpo

  • Use as labels em conformidade com as boas práticas. O seguinte artigo dá dicas de como utilizar labels. Como recomendação, separar as palavras com underscore e com todas as letras minúsculas. Em caso de dúvida, verificar alguma label já existente

  • Em caso de dúvidas, verificar nos fóruns da comunidade LaTeX. De prefrência, utilize o inglês para fazer as perguntas. Os fóruns na língua inglesa possuem mais contribuições!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages