Files
pi-new-project-dist/skills/new-project/templates/INSTALL.md.tmpl
T

80 lines
1.5 KiB
Cheetah

# INSTALL — {{PROYECTO}}
Instalación, configuración y puesta en marcha de **{{PROYECTO}}**.
{{DESCRIPCION}}
## 1. Requisitos
PENDIENTE: completar con el stack real.
| Componente | Versión mínima | Notas |
| --- | --- | --- |
| Sistema operativo | PENDIENTE | |
| Lenguaje / runtime | PENDIENTE | |
| Gestor de paquetes | PENDIENTE | |
| Otros | PENDIENTE | |
Comprueba lo instalado:
```bash
# PENDIENTE: comandos de comprobación (p. ej. python3 --version)
```
## 2. Obtener el código
```bash
git clone <url-del-repositorio>
cd {{PROYECTO}}
```
## 3. Dependencias
```bash
# PENDIENTE: instalación de dependencias
```
## 4. Configuración
PENDIENTE: variables de entorno, ficheros de configuración y secretos. Indica
qué ficheros hay que crear y de dónde copiarlos (`.env.example`, etc.).
```bash
# PENDIENTE: cp .env.example .env y editar
```
| Variable | Obligatoria | Descripción |
| --- | --- | --- |
| PENDIENTE | | |
## 5. Verificación de la instalación
```bash
# PENDIENTE: comando de humo que demuestre que funciona
```
## 6. Arranque
```bash
# PENDIENTE: comando de arranque en desarrollo y en producción
```
## 7. Actualización
```bash
git pull
# PENDIENTE: reinstalar dependencias y aplicar migraciones si las hay
```
## 8. Desinstalación
PENDIENTE: qué borrar y qué dejar.
## 9. Resolución de problemas
| Síntoma | Causa probable | Solución |
| --- | --- | --- |
| PENDIENTE | | |
Documento creado el {{FECHA}} por {{AUTOR}}.