diff --git a/README.md b/README.md index c2630c8..4e9db8a 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,68 @@ -# Boris 📚 - -**Boris** es una aplicación Android ligera diseñada para funcionar como un **gestor de biblioteca y explorador de e-Books (.epub)**, optimizada especialmente para e-Readers y dispositivos con pantallas de tinta electrónica (E-Ink). - ---- - -## 🌟 Características - -- 📁 **Navegación por Carpetas**: Explora tu catálogo local organizado por subcarpetas a partir del directorio base `/sdcard/ebooks/biblioteca`. -- 📄 **Paginación para e-Readers**: Paginación fija (6 elementos por página) pensada para evitar el parpadeo y la lentitud del *scroll* continuo en pantallas E-Ink. -- 🖼️ **Extracción Automática de Portadas**: Lee los archivos `.epub` para extraer y mostrar sus portadas automáticamente con decodificación eficiente y caché en memoria. -- 🔲 **Modos de Vista**: Cambia dinámicamente entre vista de **Lista** (1 columna) y **Cuadrícula** (3 columnas). -- 📖 **Lanzador de Lectores ePub**: Abre tus libros con tu aplicación de lectura preferida (como KOReader, Moon+ Reader, etc.) mediante intents del sistema. -- 🚀 **Pantalla Splash**: Inicio limpio con pantalla de presentación. - ---- - -## 📱 Capturas de Pantalla - -> *(Puedes agregar aquí capturas de pantalla de la aplicación corriendo en tu e-Reader o emulador)* - ---- - -## 🛠️ Requisitos e Instalación - -### Requisitos del Sistema -- **Android Min SDK:** 17 (Android 4.2 Jelly Bean) -- **Target SDK:** 34 (Android 14) -- **Permisos requeridos:** Lectura de almacenamiento externo (`READ_EXTERNAL_STORAGE`). - -### Compilación desde el código fuente -1. Clona este repositorio: - ```bash - git clone https://github.com/tu-usuario/boris.git - cd boris - ``` -2. Compila el proyecto usando Gradle: - ```bash - ./gradlew assembleDebug - ``` -3. El archivo APK generado se encontrará en `app/build/outputs/apk/debug/app-debug.apk`. -4. Instala el APK en tu dispositivo mediante ADB o directamente desde el almacenamiento. - ---- - -## 📂 Estructura del Proyecto - -``` -app/src/main/ -├── java/boris/app/ -│ ├── MainActivity.kt # Lógica de exploración, paginación, caché y extracción de portadas -│ └── SplashActivity.kt # Pantalla de inicio -└── res/ - ├── layout/ # Vistas XML (activity_main, activity_splash, item_file, item_grid) - └── drawable/ # Iconos y recursos gráficos -``` - ---- - -## 🤝 Contribuciones - -Las contribuciones, reportes de errores y sugerencias son bienvenidos. Siéntete libre de abrir un *Issue* o enviar un *Pull Request*. - ---- - -## 📄 Licencia - -Este proyecto está distribuido bajo la licencia [MIT](LICENSE). +#Biblioteca Boris 📚 + +**Biblioteca Boris** es una aplicación Android ligera diseñada para funcionar como un **gestor de biblioteca y explorador de e-Books (.epub)**, optimizada especialmente para e-Readers y dispositivos con pantallas de tinta electrónica (E-Ink). + +--- + +## 🌟 Características + +- 📁 **Navegación por Carpetas**: Explora tu catálogo local organizado por subcarpetas a partir del directorio base `/sdcard/ebooks/biblioteca`. +- 📄 **Paginación para e-Readers**: Paginación fija (6 elementos por página) pensada para evitar el parpadeo y la lentitud del *scroll* continuo en pantallas E-Ink. +- 🖼️ **Extracción Automática de Portadas**: Lee los archivos `.epub` para extraer y mostrar sus portadas automáticamente con decodificación eficiente y caché en memoria. +- 🔲 **Modos de Vista**: Cambia dinámicamente entre vista de **Lista** (1 columna) y **Cuadrícula** (3 columnas). +- 📖 **Lanzador de Lectores ePub**: Abre tus libros con tu aplicación de lectura preferida (como KOReader, Moon+ Reader, etc.) mediante intents del sistema. +- 🚀 **Pantalla Splash**: Inicio limpio con pantalla de presentación. + +--- + +## 📱 Capturas de Pantalla + +> *(Puedes agregar aquí capturas de pantalla de la aplicación corriendo en tu e-Reader o emulador)* + +--- + +## 🛠️ Requisitos e Instalación + +### Requisitos del Sistema +- **Android Min SDK:** 17 (Android 4.2 Jelly Bean) +- **Target SDK:** 34 (Android 14) +- **Permisos requeridos:** Lectura de almacenamiento externo (`READ_EXTERNAL_STORAGE`). + +### Compilación desde el código fuente +1. Clona este repositorio: + ```bash + git clone https://github.com/tu-usuario/boris.git + cd boris + ``` +2. Compila el proyecto usando Gradle: + ```bash + ./gradlew assembleDebug + ``` +3. El archivo APK generado se encontrará en `app/build/outputs/apk/debug/app-debug.apk`. +4. Instala el APK en tu dispositivo mediante ADB o directamente desde el almacenamiento. + +--- + +## 📂 Estructura del Proyecto + +``` +app/src/main/ +├── java/boris/app/ +│ ├── MainActivity.kt # Lógica de exploración, paginación, caché y extracción de portadas +│ └── SplashActivity.kt # Pantalla de inicio +└── res/ + ├── layout/ # Vistas XML (activity_main, activity_splash, item_file, item_grid) + └── drawable/ # Iconos y recursos gráficos +``` + +--- + +## 🤝 Contribuciones + +Las contribuciones, reportes de errores y sugerencias son bienvenidos. Siéntete libre de abrir un *Issue* o enviar un *Pull Request*. + +--- + +## 📄 Licencia + +Este proyecto está distribuido bajo la licencia [MIT](LICENSE).