[IMPROVED] Mejorar documentación del proyecto en README.md
- Expandir estructura de directorios con información detallada - Añadir sección de seguridad y privacidad - Reorganizar y mejorar la claridad de las explicaciones - Detallar la organización de archivos en cada directorio - Separar claramente el código (en ~/devs) de la configuración (en ~/.*) 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
a556225146
commit
9e8420c287
1 changed files with 48 additions and 17 deletions
53
README.md
53
README.md
|
@ -41,14 +41,21 @@ bin/update.sh
|
||||||
|
|
||||||
### Estructura de Directorios
|
### Estructura de Directorios
|
||||||
|
|
||||||
Durante la instalación y uso, MRDevs Tools crea varios directorios importantes:
|
MRDevs Tools utiliza una estructura organizada que separa el código (en ~/devs) y la configuración (en directorios ocultos):
|
||||||
|
|
||||||
- `~/devs/bin/`: Scripts y herramientas ejecutables
|
#### Código y scripts
|
||||||
- `~/.sounds/`: Archivos de sonido para notificaciones
|
- `~/devs/bin/`: Scripts ejecutables y herramientas principales
|
||||||
- `~/.ollama/`: Configuración y datos para Ollama AI
|
- `lib/`: Bibliotecas compartidas de funciones
|
||||||
|
- `msg/`: Archivos de mensajes multilingües
|
||||||
|
- `config/`: Configuración del sistema
|
||||||
|
|
||||||
|
#### Configuración y datos
|
||||||
|
- `~/.sounds/`: Archivos de audio para notificaciones y alertas
|
||||||
|
- `~/.ollama/`: Configuración, modelos y datos para Ollama AI
|
||||||
- `~/.vosk/`: Modelos para reconocimiento de voz local
|
- `~/.vosk/`: Modelos para reconocimiento de voz local
|
||||||
- `~/.cortana/`: Configuración y tokens para Claude Code
|
- `~/.cortana/`: Configuración y tokens para Claude Code
|
||||||
- `~/.developer/`: Tokens y configuraciones para herramientas de desarrollo
|
- `~/.developer/`: Tokens y configuraciones para herramientas de desarrollo
|
||||||
|
- `~/.cache/devs/`: Caché de descargas y datos temporales
|
||||||
|
|
||||||
## 🔧 Funcionalidades Principales
|
## 🔧 Funcionalidades Principales
|
||||||
|
|
||||||
|
@ -440,24 +447,48 @@ bin/cocomo.py --project /ruta/al/proyecto --ignore "*.generated.js" --ignore "ve
|
||||||
|
|
||||||
El script analizará el código fuente, contará las líneas efectivas, y calculará estimaciones de esfuerzo, tiempo y costos utilizando las tarifas por hora configuradas.
|
El script analizará el código fuente, contará las líneas efectivas, y calculará estimaciones de esfuerzo, tiempo y costos utilizando las tarifas por hora configuradas.
|
||||||
|
|
||||||
|
## 🔐 Seguridad y Privacidad
|
||||||
|
|
||||||
|
MRDevs Tools está diseñado con la seguridad y privacidad en mente:
|
||||||
|
|
||||||
|
- **Almacenamiento seguro**: Todos los tokens y credenciales se almacenan encriptados usando SOPS
|
||||||
|
- **Directorios ocultos**: La configuración sensible se almacena en directorios ocultos (con prefijo `.`)
|
||||||
|
- **Sin telemetría**: Las herramientas no recopilan ni envían datos de uso
|
||||||
|
- **Podman como predeterminado**: Se usa Podman (sin privilegios) para mayor seguridad en contenedores
|
||||||
|
- **Ejecución local**: Las funcionalidades como reconocimiento de voz funcionan localmente sin enviar datos
|
||||||
|
|
||||||
## 🔌 Arquitectura del Sistema
|
## 🔌 Arquitectura del Sistema
|
||||||
|
|
||||||
### Estructura de Directorios
|
### Estructura de Directorios
|
||||||
|
|
||||||
```
|
```
|
||||||
devs/
|
$HOME/
|
||||||
├── bin/ # Scripts ejecutables y herramientas
|
├── devs/ # Directorio principal del proyecto
|
||||||
|
│ └── bin/ # Scripts ejecutables y herramientas
|
||||||
│ ├── lib/ # Bibliotecas compartidas
|
│ ├── lib/ # Bibliotecas compartidas
|
||||||
│ ├── msg/ # Archivos de mensajes multilingües
|
│ ├── msg/ # Archivos de mensajes multilingües
|
||||||
│ └── config/ # Configuraciones y parámetros
|
│ ├── config/ # Configuraciones y parámetros
|
||||||
│ └── *.gitignore # Plantillas de .gitignore específicas por tipo de proyecto
|
│ │ └── *.gitignore # Plantillas para proyectos
|
||||||
|
│ ├── bootstrap.sh # Instalador básico
|
||||||
~/ (Directorio de usuario)
|
│ ├── update.sh # Actualizador de entorno
|
||||||
|
│ ├── ollama*.sh # Scripts de Ollama
|
||||||
|
│ ├── claude_voice.py # Asistente de voz para Claude Code
|
||||||
|
│ └── ... # Otros scripts
|
||||||
|
│
|
||||||
├── .sounds/ # Archivos de audio para notificaciones
|
├── .sounds/ # Archivos de audio para notificaciones
|
||||||
├── .ollama/ # Configuración y datos de Ollama (IA local)
|
├── .ollama/ # Configuración y datos de Ollama (IA)
|
||||||
|
│ ├── models/ # Modelos descargados
|
||||||
|
│ └── podman-compose.yml # Configuración del contenedor
|
||||||
|
│
|
||||||
├── .vosk/ # Modelos para reconocimiento de voz
|
├── .vosk/ # Modelos para reconocimiento de voz
|
||||||
|
│ └── models/ # Modelos de voz por idioma
|
||||||
|
│
|
||||||
├── .cortana/ # Configuración de Claude Code
|
├── .cortana/ # Configuración de Claude Code
|
||||||
|
│ └── cortana.sops.yaml # Token encriptado
|
||||||
|
│
|
||||||
└── .developer/ # Tokens y configuraciones de desarrollo
|
└── .developer/ # Tokens y configuraciones de desarrollo
|
||||||
|
├── github.sops.yaml # Token de GitHub encriptado
|
||||||
|
└── forgejo.sops.yaml # Token de Forgejo encriptado
|
||||||
```
|
```
|
||||||
|
|
||||||
### Componentes Principales
|
### Componentes Principales
|
||||||
|
|
Loading…
Reference in a new issue