Novo README

README.md

@@ -1,27 +1,50 @@
 # abntex IFPI
-Modificações ao ABNTeX para TCCs do IFPI.
+Modificações ao [abnTeX](https://github.com/abntex/abntex2) para TCCs do IFPI. Este projeto contém uma série de modificações e ajustes ao modelo abnTeX original as quais o adaptam para os padrões exigidos pelo IFPI, disponíveis através [deste link](http://www5.ifpi.edu.br/consup/attachments/article/18/Resolução%20nº%20116%20Manual%20Trabalhos%20Acadêmicos.pdf).
 
-Este projeto contém uma série de modificações e ajustes ao modelo ABNTeX original as quais o adaptam para os padrões exigidos pelo IFPI.
+O abnTeX-ifpi está na pasta abntex-ifpi. Todo o resto é meu TCC, que disponibilizo de forma integral junto ao abntex-ifpi para servir de consulta e base para trabalhos futuros :)
+
+Se você quer usar apenas o abntex-ifpi e fazer seu trabalho do seu jeito, você vai precisar apenas da pasta `abntex-ifpi`.
+
+## Encontrei um problema/erro ou gostaria que algo fosse incluído no projeto
+Caso você encontre algum erro, problema de adequação com os padrões do manual do IFPI ou precise que algo novo seja incluído (ou algo que existe removido), basta [abrir uma Issue](https://github.com/g0dkar/abntex-ifpi/issues/new) aqui mesmo no Github.
+
+## Não conheço o TeX/LaTeX... onde começar?
+Faremos em breve um guia ensinando do zero como começar a trabalhar com TeX/LaTeX e como fazer um trabalho acadêmico com ele :)
 
 ## Como Usar
-Primeiro altere os arquivos na pasta `este-trabalho`. Lá estão todos os meta-dados sobre o TCC como título, orientador, membros da banca examinadora, resumo e abstract, dedicatória, etc.
+Aqui veremos como utilizar o abntex-ifpi. Para essa parte é esperado que você tenha conhecimentos sobre TeX/LaTeX, mas nada muito avançado.
+
+### Apenas o abntex-ifpi
+**Você pode pular esta parte se for utilizar o projeto todo como base para o seu trabalho**.
+
+Para utilizar o abntex-ifpi, basta copiar a pasta `abntex-ifpi` dentro de seu projeto LaTeX e incluir o pacote com `\usepackage{abntex-ifpi/abntex-ifpi}`.
+
+### Usando este projeto como base
 
-A maioria dos arquivos tem nomes auto explicativos. Comece vendo e modificando o arquivo `este-trabalho\informacoes.tex`. Depois, na mesma pasta, veja `este-trabalho\resumo-abstract.tex`, por exemplo.
+Se você for usar esse projeto como ponto de partida é importante saber o que há em cada pasta do projeto:
 
-Após configurar as informações de seu trabalho, há mais duas coisas a fazer.
+* `abntex-ifpi`: Modificações do abnTeX para o IFPI. **Não mexa aqui**;
+* `estrutura`: Mantém as partes do documento que são o preâmbulo, pré-textual, textual e pós-textual - **Você adiciona e remove capítulos no arquivo textual.tex que fica aqui**;
+* `configuracoes`: Tem arquivos com várias configurações relacionadas ao documento final. **É aqui onde você configura o título do trabalho, Autor, Orientador e várias outras coisas**;
+* `pre-textual`: Aqui ficam os elementos pré-textuais como Resumo, Abstract, Agradecimento, etc.;
+* `pos-textual`: Aqui ficam os elementos pós-textuais como Bibliografia, Anexos, etc.;
+* `capitulos`: Aqui ficam os capítulos do trabalho.
 
-## Adicionando capítulos
-Na pasta `capitulos` ficarão os arquivos que farão a parte textual de seu trabalho. Cada arquivo `.tex` representa um capítulo completo. Se você tiver conhecimentos mais avançados de TeX sinta-se livre para criar uma estrutura de arquivos como preferir.
+O arquivo principal do projeto é o `documento.tex`, na pasta raiz. **Compile este arquivo e seu trabalho estará pronto**!
 
-Para **adicionar** um capítulo no TCC você deve:
+O banco de dados BibTeX da bibliografia do projeto fica no arquivo `bibliografia.bib`.
 
-1. Criar um arquivo para o capítulo. Neste exemplo, vamos criar `capitulos\exemplo.tex`.
-2. Adicioná-lo em `capitulos\capitulos-tcc.tex`: `\input{capitulos\exemplo}` (o `.tex` é opcional).
+### Primeiros Passos
 
-Para **remover** um capítulo basta retirar o `\input{...}` do arquivo `capitulos\capitulos-tcc.tex` (apagando ou comentando).
+Apesar de ser bem _na cara_ a forma de trabalhar e botar a coisa toda para funcionar, recomendamos que você veja os seguintes arquivos na ordem que estão apresentados:
 
-## Compilando e gerando o TCC
-Depois de configurar tudo do projeto e os capítulos basta compilar o arquivo `documento.tex` que está na raiz do projeto.
+1. `configuracoes/metadados.tex`: É onde você configura autor, titulo e outras coisas;
+2. `configuracoes/tipografia.tex`: Aqui você pode configurar que fonte seu documento vai usar;
+3. Na pasta `pre-textual`: Veja os arquivos que lhe interessarem na parte pré-textual. Observe que não há arquivos para as partes obrigatórias (como capa e folha de aprovação);
+4. `estrutura\textual.tex`: Aqui é onde você inclui e remove capítulos;
+5. Na pasta `capitulos`: Veja como são escritos os capítulos;
+6. `bibliografia.bib`: Este é o banco de dados das citações que você colocará no texto através do comando `\cite{nome-da-referencia-no-arquivo-bibliografia.bib}`;
+7. `documento.tex`: Arquivo principal do documento, e este que deve ser compilado para gerar seu trabalho.
 
-## O que falta
-Ainda não organizamos a inclusão de apêndices que, no momento, deve ser feita manualmente no arquivo `pos-textual\finalizacao.tex`.
+## O que falta?
+Fazer um tutorial legal ensinando o básico do LaTeX de forma simples :)