57 lines
1.2 KiB
Cheetah
57 lines
1.2 KiB
Cheetah
# {{PROYECTO}}
|
|
|
|
{{DESCRIPCION}}
|
|
|
|
## Estado
|
|
|
|
- Versión: `0.1.0`
|
|
- Fecha de creación: {{FECHA}}
|
|
- Autor: {{AUTOR}}
|
|
- Estado: en desarrollo
|
|
|
|
## Requisitos
|
|
|
|
PENDIENTE: lenguajes, versiones y dependencias del sistema. Ver `INSTALL.md`.
|
|
|
|
## Instalación rápida
|
|
|
|
```bash
|
|
# PENDIENTE: sustituir por los comandos reales
|
|
git clone <url-del-repositorio>
|
|
cd {{PROYECTO}}
|
|
```
|
|
|
|
Instrucciones completas en [`INSTALL.md`](INSTALL.md).
|
|
|
|
## Uso
|
|
|
|
PENDIENTE: ejemplo mínimo de uso o de arranque.
|
|
|
|
```bash
|
|
# PENDIENTE
|
|
```
|
|
|
|
## Estructura
|
|
|
|
```text
|
|
{{PROYECTO}}/
|
|
├── AGENTS.md # reglas de trabajo para agentes y colaboradores
|
|
├── README.md # este documento
|
|
├── INSTALL.md # instalación y dependencias
|
|
├── CHANGELOG.md # historial de cambios
|
|
└── TODO.md # tareas pendientes
|
|
```
|
|
|
|
## Documentación
|
|
|
|
| Documento | Contenido |
|
|
| --- | --- |
|
|
| [`AGENTS.md`](AGENTS.md) | Reglas, flujo de trabajo y convenciones. |
|
|
| [`INSTALL.md`](INSTALL.md) | Instalación, configuración y desinstalación. |
|
|
| [`CHANGELOG.md`](CHANGELOG.md) | Qué cambió y cuándo. |
|
|
| [`TODO.md`](TODO.md) | Qué falta y qué está en curso. |
|
|
|
|
## Licencia
|
|
|
|
PENDIENTE: indicar licencia del proyecto.
|