Skip to content

Commit 022ba9b

Browse files
Alan BuscagliaAlan Buscaglia
authored andcommitted
docs: create comprehensive bilingual README documentation
- Add English README.md as primary documentation - Move Spanish content to README.es.md with language links - Include detailed project vision and Alan's background - Document scientific algorithms and research foundation - Add comprehensive feature list and technology stack - Include installation instructions and development setup - Add roadmap, contribution guidelines, and contact info - Showcase research data: 52/17 ratio, SM-2, SART, JITAI - Include proven university results and effectiveness metrics
1 parent d3dbcdd commit 022ba9b

File tree

2 files changed

+454
-31
lines changed

2 files changed

+454
-31
lines changed

README.es.md

Lines changed: 241 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,241 @@
1+
# 🧠 Gentle Learning
2+
3+
**Aprendizaje científico, personalizado y sin estrés**
4+
5+
> Una aplicación web revolucionaria que transforma la forma en que estudias, utilizando algoritmos científicos para maximizar tu retención y minimizar la fatiga cognitiva.
6+
7+
[![Live Demo](https://img.shields.io/badge/🌐_Live_Demo-Gentle--Learning-E343B9?style=for-the-badge)](https://gentleman-programming.github.io/Gentle-Learning/)
8+
[![Angular](https://img.shields.io/badge/Angular-20-DD0031?style=for-the-badge&logo=angular)](https://angular.dev)
9+
[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
10+
[![Bun](https://img.shields.io/badge/Bun-000000?style=for-the-badge&logo=bun&logoColor=white)](https://bun.sh)
11+
12+
[![English](https://img.shields.io/badge/🇺🇸_English-README-blue?style=flat-square)](./README.md)
13+
14+
---
15+
16+
## 🎯 La Idea
17+
18+
Como **Alan "The Gentleman"** del canal de YouTube [Gentleman Programming](https://youtube.com/@gentlemanprogramming), siempre he creído que la tecnología debe servir para mejorar nuestra vida, no complicarla. **Gentle Learning** nace de una frustración personal: ¿por qué seguimos estudiando de la misma manera que hace 100 años cuando la neurociencia nos ha dado herramientas mucho mejores?
19+
20+
### 🚀 Mi Visión
21+
22+
**Democratizar el aprendizaje científico.** Quiero que cualquier persona, desde un estudiante de secundaria hasta un profesional aprendiendo nuevas tecnologías, tenga acceso a las mismas técnicas de estudio que usan los mejores investigadores del mundo.
23+
24+
### 💡 El Problema que Resolvemos
25+
26+
- **📚 Estudias por horas pero olvidas todo en días**
27+
- **😵 Te sientes abrumado y no sabes cuándo descansar**
28+
- **⏰ No tienes idea de cuál es tu momento óptimo para aprender**
29+
- **🔄 Repites información sin estrategia**
30+
- **📱 Las apps existentes son genéricas y no se adaptan a ti**
31+
32+
---
33+
34+
## 🧬 La Ciencia Detrás de Gentle Learning
35+
36+
Esta aplicación está basada en **investigación científica real**, no en modas o opiniones. Cada algoritmo implementado tiene respaldo empírico:
37+
38+
### 📊 Fundamentos Científicos
39+
40+
- **🔬 Spaced Repetition**: Basado en el algoritmo SM-2 de SuperMemo, con **15% más retención** que el estudio tradicional
41+
- **⏰ Ritmos Ultradianos**: Ciclos de 90-120 minutos descobridos por Nathaniel Kleitman para optimizar concentración
42+
- **🎯 Ratio 52/17**: Análisis de DeskTime de los mejores performers - **52 minutos de trabajo, 17 de descanso**
43+
- **🧠 Teoría de Carga Cognitiva**: Límite de 4±1 elementos en memoria de trabajo (John Sweller)
44+
- **🌅 Cronotipos**: Hasta **25% mejor rendimiento** cuando sincronizas con tu ritmo circadiano
45+
- **📲 JITAI Framework**: Just-in-Time Adaptive Interventions para notificaciones inteligentes
46+
47+
### 📈 Resultados Comprobados
48+
49+
- **Arizona State University**: **18% aumento** en tasas de aprobación
50+
- **University of Mississippi**: Reducción de **31% a 14.5%** en tasas de abandono
51+
- **LECTOR Algorithm**: **90.2% de efectividad** en retención
52+
53+
---
54+
55+
## ✨ Características Principales
56+
57+
### 🎯 Assessment Científico Personalizado
58+
- **SART** (Sustained Attention to Response Task) para medir tu capacidad de concentración real
59+
- **Evaluación de Cronotipos** para encontrar tu momento óptimo del día
60+
- **Análisis de Patrones** de respuesta y tiempo de reacción
61+
62+
### 🧠 Algoritmos Inteligentes
63+
- **SM-2 Modificado** para repetición espaciada personalizada
64+
- **Optimización Ultradian** que respeta tus ciclos naturales de 90 minutos
65+
- **Ajuste Dinámico** basado en tu rendimiento en tiempo real
66+
67+
### 📱 Experiencia de Usuario
68+
- **Tema Dark Accesible** - WCAG 2.1 AA compliant
69+
- **Notificaciones Inteligentes** que no te molestan
70+
- **Progreso Visual** con métricas científicas
71+
- **Adaptable** a cualquier dispositivo
72+
73+
### 🎨 Tecnología Moderna
74+
- **Angular 20** con Zoneless Change Detection
75+
- **Server-Side Rendering** para SEO óptimo
76+
- **CSS Variables** para temas personalizables
77+
- **Local Storage** para privacidad total
78+
79+
---
80+
81+
## 🛠️ Tecnologías Utilizadas
82+
83+
```typescript
84+
{
85+
"frontend": "Angular 20 + TypeScript",
86+
"runtime": "Bun (más rápido que Node.js)",
87+
"styling": "SCSS + CSS Variables",
88+
"architecture": "Zoneless + SSR + Standalone Components",
89+
"deployment": "GitHub Pages",
90+
"algorithms": "SM-2, SART, JITAI, Ultradian Cycles",
91+
"accessibility": "WCAG 2.1 AA",
92+
"data": "Local Storage (sin tracking)"
93+
}
94+
```
95+
96+
---
97+
98+
## 🚀 Inicio Rápido
99+
100+
### Prerrequisitos
101+
```bash
102+
# Instalar Bun (más rápido que npm/yarn)
103+
curl -fsSL https://bun.sh/install | bash
104+
```
105+
106+
### Instalación
107+
```bash
108+
# Clonar el repositorio
109+
git clone https://github.com/Gentleman-Programming/Gentle-Learning.git
110+
cd Gentle-Learning
111+
112+
# Instalar dependencias
113+
bun install
114+
115+
# Iniciar el servidor de desarrollo
116+
bun start
117+
```
118+
119+
### Scripts Disponibles
120+
```bash
121+
bun start # Servidor de desarrollo
122+
bun run build # Build de producción con SSR
123+
bun run build:github-pages # Build estático para GitHub Pages
124+
bun run lint # ESLint + Prettier
125+
bun run test # Tests unitarios
126+
```
127+
128+
---
129+
130+
## 🧮 Los Algoritmos en Acción
131+
132+
### 📐 Cálculo de Sesión Óptima
133+
```typescript
134+
function calculateOptimalSession(userProfile: UserProfile) {
135+
const baseAttentionSpan = userProfile.age < 18
136+
? Math.min(userProfile.age * 3, 45)
137+
: 50;
138+
139+
const sessionLength = Math.min(
140+
baseAttentionSpan,
141+
ULTRADIAN_CYCLE * 0.8 // 90 min * 0.8 = 72 min máx
142+
);
143+
144+
const breakDuration = sessionLength * 0.22; // Ratio científico
145+
146+
return { sessionLength, breakDuration };
147+
}
148+
```
149+
150+
### 🔄 Repetición Espaciada SM-2
151+
```typescript
152+
function calculateNextInterval(interval: number, easeFactor: number, quality: number) {
153+
if (quality >= 3) { // Respuesta correcta
154+
return interval === 0 ? 1 :
155+
interval === 1 ? 6 :
156+
Math.round(interval * easeFactor);
157+
}
158+
return 1; // Reiniciar si es incorrecta
159+
}
160+
```
161+
162+
---
163+
164+
## 🌟 Roadmap
165+
166+
### 🎯 Fase Actual (v1.0)
167+
- [x] Assessment científico completo
168+
- [x] Algoritmos de repetición espaciada
169+
- [x] Optimización de sesiones
170+
- [x] Tema dark accesible
171+
- [x] Deploy en GitHub Pages
172+
173+
### 🚀 Próximas Características (v2.0)
174+
- [ ] **Gamificación Científica** - Sistema de logros basado en neurociencia
175+
- [ ] **Análisis de Progreso** - Gráficos de curva de olvido personalizada
176+
- [ ] **Modo Colaborativo** - Sesiones de estudio grupales optimizadas
177+
- [ ] **IA Adaptativa** - Machine learning para predicción de rendimiento
178+
- [ ] **Integración con Calendarios** - Scheduling automático
179+
180+
### 🌍 Visión a Largo Plazo (v3.0)
181+
- [ ] **VR/AR Support** - Entornos de estudio inmersivos
182+
- [ ] **Biometric Integration** - Heart rate variability para detectar fatiga
183+
- [ ] **Multi-idioma** - Adaptación cultural de algoritmos
184+
- [ ] **Modo Offline** - PWA con sincronización
185+
186+
---
187+
188+
## 🤝 Contribuir
189+
190+
¡Las contribuciones son bienvenidas! Como desarrollador educativo, creo firmemente en el **open source** y el **aprendizaje colaborativo**.
191+
192+
### 🎯 Cómo Contribuir
193+
1. **Fork** el repositorio
194+
2. Crea una **feature branch** (`git checkout -b feature/amazing-feature`)
195+
3. **Commit** tus cambios (`git commit -m 'feat: add amazing feature'`)
196+
4. **Push** a la branch (`git push origin feature/amazing-feature`)
197+
5. Abre un **Pull Request**
198+
199+
### 📋 Áreas que Necesitan Ayuda
200+
- **🧪 Más algoritmos científicos** (FSRS, LECTOR, etc.)
201+
- **🎨 Mejoras de UX/UI**
202+
- **♿ Accesibilidad** y internacionalización
203+
- **📱 Progressive Web App** features
204+
- **🧪 Tests** unitarios y de integración
205+
206+
---
207+
208+
## 📞 Contacto
209+
210+
**Alan "The Gentleman" Buscaglia**
211+
- 🎥 **YouTube**: [@GentlemanProgramming](https://youtube.com/@gentlemanprogramming)
212+
- 🐦 **Twitter**: [@AlanBuscaglia](https://twitter.com/alanbuscaglia)
213+
- 💼 **LinkedIn**: [Alan Buscaglia](https://linkedin.com/in/alanbuscaglia)
214+
- 📧 **Email**: [email protected]
215+
216+
---
217+
218+
## 📄 Licencia
219+
220+
Este proyecto está bajo la licencia **MIT** - consulta el archivo [LICENSE](LICENSE) para más detalles.
221+
222+
---
223+
224+
## 🙏 Agradecimientos
225+
226+
- **🔬 Neuroscience Research Community** por años de investigación en aprendizaje
227+
- **🅰️ Angular Team** por una framework increíble
228+
- **🍞 Bun Team** por revolucionar el JavaScript runtime
229+
- **👥 Gentleman Programming Community** por el feedback constante
230+
231+
---
232+
233+
<div align="center">
234+
235+
### 🌟 Si te gusta el proyecto, ¡dale una estrella! ⭐
236+
237+
**Hecho con ❤️ por [Alan "The Gentleman"](https://youtube.com/@gentlemanprogramming)**
238+
239+
*"El mejor código es el que ayuda a las personas a aprender mejor"*
240+
241+
</div>

0 commit comments

Comments
 (0)