README.md in adhesiones-jekyll-theme-0.2.1 vs README.md in adhesiones-jekyll-theme-0.2.2
- old
+ new
@@ -2,35 +2,86 @@
CAMBIAME: Esta es una plantilla base para comenzar cualquier plantilla
relacionada con Sutty, con el entorno de desarrollo que usamos según
nuestro flujo de trabajo.
-La instalación de esta gema se realiza bifurcando el desarrollo de esta
-usando git, por ejemplo:
-
```bash
-# Hacer un fork local desde sutty-base-jekyll-theme a nuestra plantilla
-git clone https://0xacab.org/sutty/jekyll/sutty-base-jekyll-theme.git \
- CAMBIAME-jekyll-theme
+# Desde el directorio de trabajo
+cd ~/Sutty
+# Instalar sutty-cli antes de empezar
+gem install sutty-cli
+# Iniciar una plantilla
+sutty-cli theme CAMBIAME
+# Se creó el repositorio
cd CAMBIAME-jekyll-theme
+```
-# Sutty-base ahora es el proyecto base, desde el que podemos tomar
-# cambios, pero no enviamos para no mezclar las cosas
-git remote rename origin upstream
+Para empezar, hay que buscar y reemplazar en todos los archivos donde
+diga `CAMBIAME`.
-# Agregamos el repositorio donde vamos a enviar y publicar cambios
-git remote add origin \
- git@0xacab.org:sutty/jekyll/CAMBIAME-jekyll-theme.git
+También hay que instalar
+[sutty.local](https://0xacab.org/sutty/sutty.local/):
-# Configuramos git para que envíe siempre los cambios al repositorio
-# nuevo
-git push --set-upstream origin master
+```bash
+# Desde el directorio de trabajo
+cd ~/Sutty
+# Clonar el repositorio
+git clone https://0xacab.org/sutty/sutty.local.git
+cd sutty.local
+make all domain domain=sutty.local
+cd .. # Volver al directorio de trabajo
```
-Para empezar, hay que buscar y reemplazar en todos los archivos donde
-diga `CAMBIAME`.
+Esto genera un certificado a nivel local que luego va a usar el
+servidor de desarrollo.
-También hay que instalar las dependencias de CSS y JS con `yarn`.
+## Desarrollo
+
+Siempre trabajamos desde el directorio raíz del repositorio:
+
+```bash
+cd ~/Sutty/CAMBIAME-jekyll-theme
+```
+
+Primero hay que iniciar los servidores, antes hay que instalar el
+paquete `nghttp2`.
+
+```bash
+make serve
+```
+
+A partir de este momento podemos editar los archivos. Para probar lo
+que estamos haciendo, compilamos el sitio.
+
+```bash
+make build
+```
+
+Hay que hacer esto cada vez que queremos probar cambios.
+
+**Nota:** No usamos `jekyll serve` porque entra en conflicto con algunos
+de nuestros complementos y los sitios grandes tardan en compilarse de
+todas formas.
+
+## Actualizar
+
+Podemos traer cambios de la base:
+
+```bash
+git pull upstream master
+```
+
+Si hubiera conflictos, los podemos resolver con:
+
+```bash
+# Esto se hace una sola vez, cambiar vimdiff por la herramienta que
+# queramos usar
+git config --global mergetool.tool vimdiff
+git config --global mergetool.keepBackup false
+
+# Resolver los conflictos
+git mergetool
+```
## Publicación
Para publicar la plantilla, primero hay que cambiar el nombre al archivo
`sutty-base-jekyll-theme.gemspec`: