Skip to content

Commit 4e30603

Browse files
committed
v1.0.0: Adiciona apresentação do minicurso e atualiza README
- Organiza apresentação Beamer em pasta dedicada (apresentacao-minicurso/) - Atualiza badges com SIEEL e IEEE - Melhora seção de contatos com links reais - Adiciona foto e links dos autores - Corrige formatação de código e estrutura - Documenta apresentação usada no IEEE 2024 e SIEEL 2025
1 parent cd44568 commit 4e30603

27 files changed

Lines changed: 989 additions & 35 deletions

README.md

Lines changed: 134 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@
22

33
# 📘 The Overleafify Project
44

5+
### Desenvolvido para SIEEL & IEEE Student Branch USP São Carlos
6+
57
[![LaTeX](https://img.shields.io/badge/LaTeX-008080?style=for-the-badge&logo=latex&logoColor=white)](https://www.latex-project.org/)
68
[![Overleaf](https://img.shields.io/badge/Overleaf-47A141?style=for-the-badge&logo=overleaf&logoColor=white)](https://www.overleaf.com/)
79
[![License: Open](https://img.shields.io/badge/License-Open-blue.svg?style=for-the-badge)](LICENSE)
8-
[![IEEE](https://img.shields.io/badge/IEEE-00629B?style=for-the-badge&logo=ieee&logoColor=white)](https://ieee.org/)
10+
11+
[![SIEEL](https://img.shields.io/badge/∫IEEL-black?style=for-the-badge)](https://sieel.eesc.usp.br/)
12+
[![IEEE](https://img.shields.io/badge/IEEE-00629B?style=for-the-badge)](https://ieee.org/)
913

1014
*Um guia prático e acessível para dominar LaTeX e Overleaf*
1115

@@ -65,13 +69,45 @@ O livro está organizado em capítulos progressivos, cobrindo desde fundamentos
6569

6670
---
6771

72+
## 🎤 Apresentação do Minicurso
73+
74+
A apresentação em **Beamer** utilizada durante o minicurso está disponível no repositório! Ela contém slides sobre todos os tópicos abordados, exemplos práticos e exercícios.
75+
76+
### 📂 Conteúdo da Apresentação
77+
78+
| Seção | Tópico |
79+
|-------|--------|
80+
| 1️⃣ | Introdução ao LaTeX |
81+
| 2️⃣ | Tipos de Documentos |
82+
| 3️⃣ | Formatação de Texto |
83+
| 4️⃣ | Tabelas, Figuras e Matemática |
84+
| 5️⃣ | Bibliografia e Citações |
85+
| 6️⃣ | Modelos e Relatórios |
86+
| 7️⃣ | Exercícios Práticos |
87+
| 8️⃣ | Dúvidas e Dicas Finais |
88+
| 9️⃣ | Convite Sanca Week |
89+
90+
### 🎨 Como Usar a Apresentação
91+
92+
**No seu computador:**
93+
```bash
94+
cd apresentacao-minicurso
95+
pdflatex main.tex
96+
```
97+
98+
**No Overleaf:**
99+
- Faça upload da pasta `apresentacao-minicurso/` completa
100+
- Compile o `main.tex`
101+
102+
---
103+
68104
## 🚀 Como Usar
69105

70106
### Opção 1: Compilar Localmente
71107

72108
Você pode compilar o documento LaTeX localmente no seu computador:
73109

74-
\\\ash
110+
```bash
75111
# Clone o repositório
76112
git clone https://github.com/FatsyAlst/the-overleafify-project.git
77113
cd the-overleafify-project
@@ -84,26 +120,37 @@ pdflatex main.tex
84120
bibtex main
85121
pdflatex main.tex
86122
pdflatex main.tex
87-
\\\
123+
```
88124

89125
### Opção 2: Usar no Overleaf
90126

91-
1. Faça upload de todos os arquivos da pasta \latex-doc/\ para um novo projeto no [Overleaf](https://www.overleaf.com)
92-
2. Compile o arquivo \main.tex\
127+
1. Faça upload de todos os arquivos da pasta `latex-doc/` para um novo projeto no [Overleaf](https://www.overleaf.com)
128+
2. Compile o arquivo `main.tex`
93129
3. Explore e modifique conforme necessário!
94130

95-
### Opção 3: Download Direto
131+
### Opção 3: Apresentação do Minicurso
132+
133+
A apresentação utilizada durante o minicurso está disponível na pasta `apresentacao-minicurso/`:
134+
135+
```bash
136+
cd apresentacao-minicurso
137+
pdflatex main.tex
138+
```
139+
140+
Ou use no [Overleaf](https://www.overleaf.com) fazendo upload dos arquivos.
141+
142+
### Opção 4: Download Direto
96143

97144
*Em breve: PDF compilado disponível para download direto*
98145

99146
---
100147

101148
## 🛠️ Estrutura do Repositório
102149

103-
\\\
150+
```
104151
the-overleafify-project/
105152
106-
├── latex-doc/ # Código-fonte LaTeX
153+
├── latex-doc/ # Código-fonte do livro
107154
│ ├── capitulos/ # Capítulos do livro
108155
│ │ ├── 1_typer_doc_struct.tex
109156
│ │ ├── 2_text_formatacao.tex
@@ -123,29 +170,42 @@ the-overleafify-project/
123170
│ ├── apendice.tex # Apêndice
124171
│ └── referencias.bib # Bibliografia
125172
173+
├── apresentacao-minicurso/ # Apresentação Beamer do minicurso
174+
│ ├── main.tex # Arquivo principal da apresentação
175+
│ ├── content/ # Configurações e cabeçalho
176+
│ ├── sections/ # Seções da apresentação
177+
│ └── images/ # Imagens da apresentação
178+
126179
└── README.md # Este arquivo
127-
\\\
180+
```
128181

129182
---
130183

131184
## 👥 Autores
132185

186+
<div align="center">
187+
133188
<table>
134189
<tr>
135190
<td align="center">
136191
<a href="https://github.com/FatsyAlst">
137-
<img src="https://github.com/FatsyAlst.png" width="100px;" alt="Felipe Silva"/><br />
192+
<img src="https://github.com/FatsyAlst.png" width="100px;" alt="Felipe Silva" style="border-radius:50%"/><br />
138193
<sub><b>Felipe Silva</b></sub>
139194
</a><br />
140195
<sub>Co-autor & Instrutor</sub>
141196
</td>
142197
<td align="center">
143-
<sub><b>Yuri Thadeu</b></sub><br />
198+
<a href="https://github.com/YuriThadeu">
199+
<img src="https://github.com/YuriThadeu.png" width="100px;" alt="Yuri Thadeu" style="border-radius:50%"/><br />
200+
<sub><b>Yuri Thadeu</b></sub>
201+
</a><br />
144202
<sub>Co-autor & Instrutor</sub>
145203
</td>
146204
</tr>
147205
</table>
148206

207+
</div>
208+
149209
### 🏛️ Afiliação
150210

151211
**IEEE Student Branch USP São Carlos**
@@ -192,9 +252,9 @@ O curso cobre desde fundamentos até técnicas avançadas, com foco em exercíci
192252
Contribuições são bem-vindas! Se você encontrou erros, tem sugestões ou quer adicionar conteúdo:
193253

194254
1. Fork este repositório
195-
2. Crie uma branch para sua feature (\git checkout -b feature/MelhoriaIncrivel\)
196-
3. Commit suas mudanças (\git commit -m 'Adiciona MelhoriaIncrivel'\)
197-
4. Push para a branch (\git push origin feature/MelhoriaIncrivel\)
255+
2. Crie uma branch para sua feature (`git checkout -b feature/MelhoriaIncrivel`)
256+
3. Commit suas mudanças (`git commit -m 'Adiciona MelhoriaIncrivel'`)
257+
4. Push para a branch (`git push origin feature/MelhoriaIncrivel`)
198258
5. Abra um Pull Request
199259

200260
---
@@ -211,37 +271,76 @@ Este livro é distribuído sob uma **licença aberta**. A cópia, reprodução e
211271

212272
Para dúvidas, sugestões ou mais informações sobre o projeto:
213273

214-
- 📫 Entre em contato através do [IEEE Student Branch USP São Carlos](https://ieee.org/)
215-
- 💬 Abra uma issue neste repositório
216-
- 🔗 Conecte-se no [LinkedIn](https://www.linkedin.com/in/felipe-silva)
274+
- 📷 Instagram: [@ieeeuspsc](https://www.instagram.com/ieeeuspsc/)
275+
- 💼 LinkedIn: [IEEE Student Branch USP São Carlos](https://www.linkedin.com/company/ieeeuspsc/)
276+
- 💬 Abra uma [issue neste repositório](https://github.com/FatsyAlst/the-overleafify-project/issues)
277+
278+
**Autores:**
279+
- 🔗 [Felipe Silva - LinkedIn](https://www.linkedin.com/in/felipe-silva-93407b1b2/)
280+
- 🔗 [Yuri Thadeu - LinkedIn](https://www.linkedin.com/in/yuri-thadeu/)
217281

218282
---
219283

220284
## 🌐 English Version
221285

222-
### About The Project
286+
### 📘 About The Project
287+
288+
**The Overleafify Project** is a practical and accessible guide to LaTeX and Overleaf, developed as teaching material for a minicourse at **SIEEL** and **IEEE Student Branch USP São Carlos**. This book empowers students and researchers to produce high-quality academic and technical documents, from beginner to advanced level.
289+
290+
### 📖 Overview
291+
292+
This comprehensive guide covers everything from basic concepts like document structure and text formatting to advanced topics including tables, images, mathematical expressions, bibliographies, and graphics. Additionally, it explores creating professional presentations with **Beamer** and customizing layouts for specific project needs. With practical examples, exercises, and useful tips, this guide aims to help newcomers master these tools efficiently, making scientific documentation clearer, more organized, and aesthetically appealing.
293+
294+
### 🎯 Objectives
295+
296+
- ✅ Introduce fundamental LaTeX concepts
297+
- ✅ Provide practical exercises to consolidate learning
298+
- ✅ Demonstrate real applications in academic documents
299+
- ✅ Teach professional presentation creation with Beamer
300+
- ✅ Enable autonomous production of technical documents
301+
302+
### 📚 Book Contents
303+
304+
The book is organized in progressive chapters, covering from fundamentals to advanced techniques:
305+
306+
| # | Topic | Description |
307+
|---|-------|-------------|
308+
| 1️⃣ | **Document Types & Structure** | Understanding classes, preamble, and organization |
309+
| 2️⃣ | **Text Formatting** | Fonts, styles, lists, and alignment |
310+
| 3️⃣ | **Tables** | Creating and formatting professional tables |
311+
| 4️⃣ | **Image Manipulation** | Insertion, positioning, and references |
312+
| 5️⃣ | **Mathematical Expressions** | Equations, symbols, and math environments |
313+
| 6️⃣ | **Bibliographies & Citations** | Reference management with BibTeX |
314+
| 7️⃣ | **Professional Layouts** | Customization and advanced templates |
315+
| 8️⃣ | **Graphics & Diagrams** | TikZ and data visualization |
316+
| 9️⃣ | **Beamer (Presentations)** | Professional slides in LaTeX |
317+
318+
### 📦 Additional Content
223319

224-
**The Overleafify Project** is an introductory and accessible guide to LaTeX and Overleaf, developed as teaching material for a minicourse at SIEEL and IEEE Student Branch USP São Carlos. This book covers everything from basic document structure to advanced topics like mathematical expressions, bibliographies, professional layouts, and Beamer presentations.
320+
- **Preface**: Project context and motivation
321+
- **Introduction**: TeX vs LaTeX, WYSIWYG vs WYSIWYM
322+
- **Appendix**: Complementary resources and references
323+
- **Practical examples**: Ready-to-use code
324+
- **Solved exercises**: Material for guided practice
225325

226-
### Key Features
326+
### 🎯 Who Is This For?
227327

228-
- 📖 Comprehensive guide from beginner to advanced
229-
- 💡 Practical exercises in every chapter
230-
- 🎨 Real-world academic examples
231-
- 🆓 Free and open access
232-
- 🇧🇷 Written in Brazilian Portuguese
328+
- 📚 **University students** starting with academic writing
329+
- 🔬 **Researchers** producing papers and theses
330+
- 👨‍🎓 **Undergraduate research students** learning technical documentation
331+
- 💼 **Professionals** working with technical documentation
332+
- 🎓 **Anyone** interested in learning LaTeX from scratch
233333

234-
### Contents
334+
### 🌟 Key Features
235335

236-
9 progressive chapters covering:
237-
- Document types and structure
238-
- Text formatting
239-
- Tables and figures
240-
- Mathematical expressions
241-
- Bibliography management
242-
- Professional layouts
243-
- Graphics and diagrams
244-
- Beamer presentations
336+
| Feature | Description |
337+
|---------|-------------|
338+
| 📘 **Didactic** | Accessible and progressive language |
339+
| 💡 **Practical** | Hands-on exercises in each chapter |
340+
| 🎨 **Visual** | Visual examples and well-formatted content |
341+
| 🆓 **Free** | Open and freely accessible material |
342+
| 🇧🇷 **Portuguese** | Content in Brazilian Portuguese |
343+
|**Complete** | From basics to advanced in one guide |
245344

246345
---
247346

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
% Definindo novas cores
2+
3+
\definecolor{ieeeblue}{RGB}{0,98,155}
4+
\definecolor{darkteal}{RGB}{0,115,119}
5+
\definecolor{darkblue}{RGB}{0,40,85}
6+
\definecolor{black}{RGB}{0,0,0}
7+
8+
% Aplicando as cores ao tema
9+
\setbeamercolor{structure}{fg=ieeeblue} % títulos, bullets etc.
10+
\setbeamercolor{title}{fg=white}
11+
\setbeamercolor{frametitle}{bg=ieeeblue, fg=white}
12+
\setbeamercolor{item}{fg=ieeeblue}
13+
\setbeamercolor{footline}{bg=darkblue, fg=white}
14+
\setbeamercolor{author in head/foot}{fg=white}
15+
\setbeamercolor{title in head/foot}{fg=white}
16+
\setbeamercolor{normal text}{fg=black, bg=white}
17+
18+
% Cabeçalho
19+
20+
% Adiciona as logos nos cantos
21+
\titlegraphic{%
22+
\vfill
23+
\includegraphics[width=2.5cm]{images/ieee_logo.png}\hspace{0.8cm}%
24+
\includegraphics[width=3cm]{images/Logo IEEE - USP São Carlos.png}\\%\\)
25+
\vspace{0.5cm}
26+
\includegraphics[width=2cm]{images/logoSIEEL_preto.png}
27+
}
28+
29+
%\setbeamercolor{section in head/foot}{bg=darkblue, fg=white} %cor do cabeçalho
30+
\setbeamertemplate{headline}{
31+
\leavevmode%
32+
\hbox{%
33+
\begin{beamercolorbox}[wd=\paperwidth,ht=2.5ex,dp=1ex,center]{section in head/foot}
34+
\textbf{\insertsection} % ou \inserttitle para mostrar o título do slide
35+
\end{beamercolorbox}%
36+
}
37+
\vskip0pt
38+
}
39+
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
% Tema
2+
\usetheme{Madrid}
3+
4+
% Pacotes adicionais
5+
\usepackage[utf8]{inputenc}
6+
\usepackage{graphicx}
7+
\usepackage{xcolor}
8+
\usepackage[brazilian]{babel}
9+
\usepackage{subcaption}
10+
\usepackage{verbatim}
11+
\usepackage{tabularx} % Tabelas com largura ajustável
12+
13+
\usepackage{xspace} % Carrega o pacote xspace, que insere automaticamente um espaço após macros
14+
\newcommand{\LaTeXcmd}{\LaTeX\xspace} % Define \LaTeXcmd como um atalho para \LaTeX, e usa \xspace para adicionar um espaço quando o próximo caractere for alfanumérico, evitando precisar escrever {} ou \, toda vez.
15+
\newcommand{\TeXcmd}{\TeX\xspace} % Define \TeXcmd análogo a \LaTeXcmd, mas para o logo \TeX.
16+
17+
% AMBIENTE PARA CÓDIGO-FONTE
18+
%--------------------------------------------------------
19+
\usepackage{listings} % Permite incluir e formatar código-fonte
20+
\lstset{
21+
language=tex, % Linguagem usada no código (aqui: LaTeX)
22+
basicstyle=\ttfamily\small, % Fonte monoespaçada pequena
23+
commentstyle=\color{gray}, % Cor dos comentários
24+
frame=single, % Moldura em volta do código
25+
breaklines=true, % Quebra linhas automaticamente
26+
captionpos=b % Posição da legenda (b = abaixo)
27+
}
28+
29+
\renewcommand{\lstlistingname}{Código} % Muda o nome padrão de "Listing" para "Código"
30+
31+
% Suporte para acentuação correta dentro do ambiente de código
32+
% Resolve um tipo de erro bem especifico em blocos de codigo
33+
\lstset{
34+
literate={á}{{\'a}}1 {é}{{\'e}}1 {í}{{\'i}}1 {ó}{{\'o}}1 {ú}{{\'u}}1
35+
{ã}{{\~a}}1 {õ}{{\~o}}1 {â}{{\^a}}1 {ê}{{\^e}}1 {ô}{{\^o}}1
36+
{À}{{\`A}}1 {à}{{\`a}}1 {ü}{{\"u}}1 {ç}{{\c{c}}}1 {Ç}{{\c{C}}}1
37+
{ö}{{\"o}}1
38+
}
183 KB
Loading
255 KB
Loading
115 KB
Loading
74 KB
Loading
114 KB
Loading
619 KB
Loading
42.3 KB
Loading

0 commit comments

Comments
 (0)