Olá! Bem vindo ao limarka!

<!-- Show what you're doing, for who, and why. -->

O limarka é uma ferramenta que possibilita seus usuários escreverem relatórios ou trabalhos de conclusão de curso (Monografia, TCC, Dissertação ou Tese) em arquivos somente texto e produzir PDFs em conformidades com as Normas da ABNT. A produção desse tipo de trabalho é um momento sensível na vida dos estudantes, que pode contribuir para evasão no ensino superior. O objetivo do limarka é liberar dos estudantes os esforços de formatação e adequação às Normas da ABNT, deixando-os concentrar-se no planejamento, execução e escrita de seus trabalhos.

Quem utiliza o limarka diz que ele é fácil e prazeroso, descubra o porquê!

<!-- Explain what makes your project special, useful, exciting! -->

• Exige conhecimentos mínimos sobre as Normas da ABNT
• Utiliza modelo com estilos pré-configurados com as normas e de fácil utilização
• Utiliza sistema para gerenciamento de citações e elaboração das referências automaticamente
• Gera o sumário automaticamente, sem esforço adicional
• Permite a escrita do trabalho em arquivos somente texto, utilizando Markdown
• As configurações são realizadas em um arquivo de formulário em PDF

Exemplo de utilização do limarka

Como iniciar utilização

<!-- Show how to get started using or contribution to the project -->

• Para começar a utilizar a ferramenta siga as instruções no wiki do projeto
• Lembre-se de acessar o chat no gitter para tirar suas dúvidas sobre a ferramenta.

Contribuindo com o projeto

<!-- State what resources and contributions you're looking for -->

Veja como é fácil contribuir!

Professor

• Atualize sua página pessoal/institucional adicionando uma matéria ou link sobre o limarka
• Solicite incluir o limarka como uma alternativa nos materiais de instruções de produção de trabalhos de conclusão, ou nas disciplinas de Metodologia.
• Ao solicitar relatórios de atividades aos alunos, sugira a utilização do limarka.
• Divulgue um notícia sobre o limarka nas listas de professores ou alunos.
• Recomende a veiculação de uma matéria sobre o limarka na agência de noticias de sua instituição.
• Sugira seus orientandos experimentarem o limarka.
• Clique na estrela no repositório do projeto (equivale a um like)

Estudante

• Utilize o limarka para elaboração de relatórios
• Participe do experimente de uso da ferramenta - NECESSITA-SE URGENTEMENTE!
• Compartilhe alguma notícia do limarka em suas redes sociais ou lista de alunos
• Escreva seu trabalho de conclusão com o limarka e compartilhe sua experiência
• Clique na estrela no repositório do projeto (equivale a um like)

Usuário Latex

• Auxilie na criação de templates latex customizados para as instituições

Desenvolvedor Ruby

• Escolha uma das funcionalidades para implementar
• Notifique ou corrija um Bug

Acesse o chat no gitter e fale conosco!

Desenvolvedor Web

Nós desejamos melhorar a experiência de utilização da ferramenta implementando um site que gere conteúdos dinâmicos, gostaria de contribuir?

Acesse o chat no gitter e fale conosco!

Todas as formas de contribuição

Consulte o arquivo CONTRIBUTING.md para verificar todas as formas de contribuições.

<!-- Point to other key resources, such as a contributing.md file and a roadmap. -->

Deseja entrar em contato?

O meio de comunicação oficial do limarka é uma sala de bate papo no gitter:

Links

• A documentação do limarka será mantida no wiki do projeto.
• Vídeos -- recomendo assistir em velocidade rápida
• Convite para realização de experimento de utilização

Funcionalidades do limarka

• Utilização da linguagem Markdown para escrita do texto;
• Configurações através de formulário PDF ou arquivo YAML;
• Possibilidade de inclusão de códigos Latex;
• Facilidade para geração de códigos para inclusão de Figuras, Quadros, Tabelas, Referências e Citações;
• Facilidade em edição ou personalização de templates;
• Facilidade de obter suporte ao código Latex gerado (compatível com o estilo do abnTeX2);

License

Esse gem é disponibilizado como software livre através da Licença MIT.