Adrien Ufferte
128 lines
3.8 KiB
Markdown
128 lines
3.8 KiB
Markdown
# 📖 Kalulu — Aprenda a Ler de Forma Inteligente
|
||
|
||
## 🌍 Idiomas Disponíveis
|
||
|
||
- 🇬🇧 [English](README.md)
|
||
- 🇫🇷 [Français](README.fr.md)
|
||
- 🇪🇸 [Español](README.es.md)
|
||
|
||
---
|
||
|
||
## 📚 Índice
|
||
|
||
- [🧠 Por que Kalulu?](#por-que-kalulu)
|
||
- [✨ Funcionalidades](#funcionalidades)
|
||
- [🚀 Como começar](#como-começar)
|
||
- [1. Clonar o repositório](#1-clonar-o-repositório)
|
||
- [2. Instalar o Godot Engine](#2-instalar-o-godot-engine)
|
||
- [🧩 Addons inclusos](#-addons-inclusos)
|
||
- [🤝 Quer ajudar?](#-quer-ajudar-)
|
||
- [❓ Perguntas Frequentes](#faq)
|
||
|
||
---
|
||
|
||
## 🧠 Por que Kalulu?
|
||
|
||
**Kalulu** é mais que um jogo — é uma jornada educativa baseada em ciência para ensinar crianças a ler usando técnicas de decodificação.
|
||
|
||
Cada lição segue uma sequência estruturada com base em dados da literatura infantil.
|
||
|
||
- 🎯 **Objetivo**: Tornar a leitura acessível, divertida e eficaz
|
||
- 🌟 **Base científica**: Criado com base em pesquisas em educação e neurociência
|
||
- 👶 **Público-alvo**: Crianças, mas útil para qualquer pessoa começando a ler
|
||
- 🔎 **Pesquisas publicadas**: Vários artigos foram publicados sobre o design do Kalulu e os resultados de leitura, leia aqui:
|
||
https://www.tandfonline.com/doi/pdf/10.1080/00220973.2023.2173129
|
||
https://hal.science/hal-03015914/document
|
||
https://hal.science/hal-03702075/document
|
||
|
||
---
|
||
|
||
## ✨ Funcionalidades
|
||
|
||
- Lições interativas de leitura grafema-fonema
|
||
- Progressão adaptativa de dificuldade
|
||
- Interface amigável para crianças com visuais envolventes
|
||
|
||
---
|
||
|
||
## 🚀 Como começar
|
||
|
||
### 1. 📥 Clonar o repositório
|
||
|
||
```bash
|
||
# Clone o seu fork do repositório
|
||
git clone https://github.com/SEU_USUARIO/Kalulu-Frontend.git
|
||
# Ou então
|
||
git clone git@github.com:YOUR_USERNAME/Kalulu-Frontend.git
|
||
|
||
cd Kalulu-Frontend
|
||
```
|
||
|
||
🔁 _Substitua `SEU_USUARIO` pelo seu nome de usuário._
|
||
|
||
---
|
||
|
||
### 2. 🎮 Instalar o Godot Engine
|
||
|
||
- Baixe de [godotengine.org](https://godotengine.org/)
|
||
- Escolha o seu sistema e abra o editor
|
||
|
||
---
|
||
|
||
## 🧩 Addons inclusos
|
||
|
||
- 🔄 **EnvironmentSwitcher** – Alterna entre ambiente de dev e produção
|
||
- 📤 **export_tool_manager** – Exportação facilitada
|
||
- ✅ **godot-form-validator** – Validação de UI no Godot 4
|
||
- 🗃️ **godot-sqlite** – Integração com SQLite
|
||
|
||
> ⚠️ Baixe `godot-sqlite` manualmente do AssetLib.
|
||
|
||
---
|
||
|
||
## 🤝 Quer ajudar?
|
||
|
||
Sua contribuição é muito bem-vinda!
|
||
|
||
1. **Configure o projeto**
|
||
Veja a [seção de Como começar](#como-começar) para saber como fazer fork e clonar o repositório.
|
||
|
||
2. **Crie um novo branch**
|
||
```bash
|
||
git checkout -b feature/nome-da-sua-funcionalidade
|
||
```
|
||
|
||
3. **Faça suas alterações**
|
||
Implemente as melhorias ou correções.
|
||
|
||
4. **Comite e envie para o repositório**
|
||
```bash
|
||
git add .
|
||
git commit -m "Descreva suas alterações"
|
||
git push origin feature/nome-da-sua-funcionalidade
|
||
```
|
||
|
||
5. **Abra um Pull Request**
|
||
Vá até seu fork no GitHub e clique em **Compare & pull request** para enviar suas alterações para revisão.
|
||
|
||
Certifique-se de que seu código siga nossas convenções de codificação e inclua os testes ou atualizações de documentação relevantes quando apropriado.
|
||
|
||
---
|
||
|
||
## ❓ FAQ
|
||
|
||
### 📱 O Kalulu está disponível para dispositivos móveis?
|
||
|
||
Sim! Kalulu está disponível para:
|
||
|
||
- [](https://play.google.com/store/apps/details?id=org.godotengine.kalulu)
|
||
- [](https://apps.apple.com/fr/app/kalulu-education/id1639075967)
|
||
|
||
### 💻 O Kalulu está disponível no desktop?
|
||
|
||
Sim! Versões para Windows, Mac e Linux estão disponíveis na seção [Releases](https://github.com/Excello-Recherche-Education/Kalulu-Frontend/releases).
|
||
|
||
### 🌐 O Kalulu está disponível diretamente na web?
|
||
|
||
Estamos trabalhando nisso, fique ligado!
|