Skip to content

Commit 54efad6

Browse files
committed
Add README.md with project overview, installation instructions, and usage guidelines
1 parent 822786e commit 54efad6

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed

README.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# 📄 DocsTalker - Analisador de PDFs
2+
3+
Ferramenta interativa para análise e conversação com documentos PDF utilizando modelos de linguagem avançados e interface Streamlit.
4+
5+
## 🎯 Funcionalidades
6+
- Carregamento e análise de múltiplos PDFs
7+
- Interface conversacional intuitiva
8+
- Processamento de texto avançado com IA
9+
- Extração inteligente de informações
10+
11+
## ⚙️ Pré-requisitos
12+
- Python 3.9 ou superior
13+
- Conta na OpenAI com chave de API
14+
- Conexão com internet
15+
16+
## 🚀 Instalação
17+
1. Clone o repositório:
18+
```bash
19+
git clone https://github.com/seu-usuario/docsTalker.git
20+
cd docsTalker
21+
```
22+
23+
2. Instale as dependências:
24+
```bash
25+
pip install -r requirements.txt
26+
```
27+
28+
3. Configure as variáveis de ambiente:
29+
- Copie o arquivo `.env.example` para `.env`
30+
- Adicione sua chave da API OpenAI e outras configurações necessárias
31+
32+
## 💻 Uso
33+
1. Inicie a aplicação:
34+
```bash
35+
streamlit run Home.py
36+
```
37+
38+
2. Acesse através do navegador (geralmente http://localhost:8501)
39+
3. Faça upload dos PDFs desejados
40+
4. Comece a interagir com seus documentos!
41+
42+
## 📁 Estrutura do Projeto
43+
```
44+
docsTalker/
45+
├── Home.py # Aplicação principal
46+
├── pages/ # Páginas adicionais
47+
├── utils/ # Utilitários e configurações
48+
├── requirements.txt # Dependências
49+
└── .env # Configurações locais
50+
```
51+
52+
## 🤝 Contribuindo
53+
Contribuições são bem-vindas! Sinta-se à vontade para:
54+
- Reportar bugs
55+
- Sugerir novas features
56+
- Enviar pull requests
57+
58+
## 📝 Licença
59+
Este projeto está sob a licença MIT.

requirements.txt

3.63 KB
Binary file not shown.

0 commit comments

Comments
 (0)