Skip to content

Commit 699f805

Browse files
committed
docs(readme): replace with clean, single-block Spanish README
1 parent 3caa722 commit 699f805

File tree

1 file changed

+75
-0
lines changed

1 file changed

+75
-0
lines changed

README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,80 @@
11
# dotfiles
22

3+
Colección de configuraciones (dotfiles) que uso en varias máquinas y entornos. Este repositorio agrupa módulos organizados para facilitar su despliegue mediante `stow` (Unix) y scripts de ayuda (Windows).
4+
5+
## Inicio rápido — Linux / WSL
6+
```bash
7+
git clone --recurse-submodules https://github.com/JotaRandom/dotfiles.git ~/dotfiles
8+
cd ~/dotfiles
9+
git lfs install
10+
git lfs pull
11+
git submodule update --init --recursive
12+
./scripts/install.sh
13+
```
14+
15+
## Inicio rápido — PowerShell / Windows
16+
```powershell
17+
git clone https://github.com/JotaRandom/dotfiles.git $HOME\dotfiles
18+
cd $HOME\dotfiles
19+
git lfs install
20+
git lfs pull
21+
git submodule update --init --recursive
22+
.\scripts\install.ps1
23+
```
24+
25+
Para instrucciones más detalladas revisa `docs/INSTALL.md`.
26+
27+
## Estructura
28+
- `modules/`: módulos por función (e.g. `modules/shell/bash`).
29+
- `machines/`: configuraciones históricas específicas de hardware.
30+
- `assets/`: binarios y recursos multimedia (Git LFS).
31+
- `distros/`: configuraciones por distribución y submodules (PKGBUILD).
32+
- `scripts/`: scripts de utilidad (instalador, githooks, actualización de submodules).
33+
34+
## Propósito
35+
Guardar y versionar configuraciones, dotfiles y snippets que faciliten el despliegue y la configuración de entornos.
36+
37+
## Instalación y uso
38+
1. Prepara el repositorio (submodules + LFS):
39+
```bash
40+
git clone --recurse-submodules https://github.com/JotaRandom/dotfiles.git ~/dotfiles
41+
cd ~/dotfiles
42+
git lfs install
43+
git lfs pull
44+
git submodule update --init --recursive
45+
```
46+
2. Instala dependencias (ej. `stow` en Linux): Debian/Ubuntu: `sudo apt install stow git-lfs` — Arch: `sudo pacman -S stow git-lfs`.
47+
3. Aplica módulos con `stow` o usa el instalador:
48+
```bash
49+
./scripts/install.sh modules/shell/bash modules/editor/nvim
50+
```
51+
En Windows (PowerShell):
52+
```powershell
53+
.\scripts\install.ps1 modules/shell/bash
54+
```
55+
56+
### Nota sobre cambios a nivel sistema
57+
Los instaladores incluidos solo aplican dotfiles de usuario en `$HOME`. No se modifican archivos de sistema (`/etc/*`) automáticamente. Para aplicar archivos de sistema, sigue las instrucciones manuales en `docs/INSTALL.md`.
58+
59+
## Hooks Git
60+
El repositorio incluye hooks en `.githooks` que, por ejemplo, marcan archivos con shebang como ejecutables en el índice.
61+
- Activación automática: los instaladores configuran `core.hooksPath` a `.githooks` en tu clon local (idempotente).
62+
- Activación manual: `./scripts/setup-githooks.sh` (o `setup-githooks.ps1`).
63+
- Revertir: `git config --unset core.hooksPath`.
64+
65+
## Contribuir
66+
- Pull requests y Issues bienvenidos. Prevén PRs pequeños y fáciles de revisar.
67+
68+
## Licencia
69+
Revisa `CC-SA-4.0` y `GPL-2.0` en la raíz del repo para detalles.
70+
71+
## Notas sobre Git LFS
72+
Instala `git-lfs` antes de trabajar con los assets (ej.: `assets/poni`) si clonas el repo.
73+
74+
## Contacto
75+
Abre un issue o contacta al mantenedor (perfil `JotaRandom` en GitHub).
76+
# dotfiles
77+
378
Colección personal de configuraciones y dotfiles para distintas máquinas y entornos. Aquí se agrupan módulos de configuración, archivos históricos y extras organizados para ser fáciles de desplegar con `stow` (en Unix) o mediante scripts en Windows.
479

580
## Inicio rápido (Linux / WSL)

0 commit comments

Comments
 (0)