Automatizando proceso de empaquetado

Author: twilight1794

README.md

@@ -23,6 +23,19 @@
 - Puertos e instrucciones I/O
 - Características avanzadas de macros
 
+## Compilación
+
+Para generar los ejecutables y el instalador desde un sistema Unix, se requieren las siguientes dependencias:
+
+- `makensis` para generar el instalador para Windows
+- `node` y `neu` para generar los ejecutables
+- `gcab` para empaquetar la versión portable para Windows
+- `sed` para versionar automáticamente los archivos fuente
+
+En la terminal, ejecuta `./preparar.sh todo $version`, donde `$version` es el número de versión a generar. Eso generará todos los archivos para distribuir. Para limpiar el espacio de trabajo, puedes ejecutar `./preparar.sh limpiar`.
+
+Para hacerlo desde un sistema Windows, el proceso debería ser similar, o también se puede utilizar WSL.
+
 ## Créditos
 
 - Integrantes del equipo, en orden alfabético:
@@ -32,11 +45,14 @@
   - Santiago Rodríguez
   - Carlos Villaseñor
 - **Logotipo**:
-  - Fue tomado del [tema de íconos Papirus](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)
+  - Creado por Santiago Rodríguez
   - Tiene licencia GPLv3
 - **NeutralinoJS**:
   - Usamos NeutralinoJS para generar los binarios para Windows y Linux
   - Tiene licencia MIT
+- **NSIS**:
+  - Usamos NSIS para generar los instaladores para Windows
+  - Tiene licencia zlib
 - **Tipografías**:
   - Predeterminadamente, usamos dos tipografías:
   - *Carlito*: reemplazo libre de Calibri, para el texto base

doc/readme.md renamed to doc/README.md

@@ -2,7 +2,7 @@
 
 En este espacio puede encontrar ayuda para utilizar el programa. Esta ayuda se divide en dos partes:
 
-* **[Manual de usuario](usuario.adoc)**: Dirigida a explicar el funcionamiento y las opciones disponibles del propio programa
+* **Manual de usuario** ([es](usuario.es.adoc), [en](usuario.en.adoc)): Dirigida a explicar el funcionamiento y las opciones disponibles del propio programa
 * **[Manual técnico](tecnico.adoc)**: Dirigida a explicar el formato ensamblador implementado, así como las directivas reconocidas
 
 Esperamos que este contenido les sea de utilidad, y siempre puede informar sobre sugerencias, peticiones y correcciones en la [sección de Incidencias](https://github.com/twilight1794/z80/issues) de GitHub.

instalador.nsi

@@ -1,50 +1,45 @@
-!include MUI2.nsh
-!define VERSION "1.0.0"
-!define NOMBRE "Emulador Z80"
+!define NOMBRE "RetroZ80Simulator"
 !define NOMBRE_CORTO "z80"
+!define COMENTARIO "Ensamblador y emulador libre del microprocesador Zilog Z80"
+
+VIFileVersion ${VERSION}
+VIProductVersion ${VERSION}
+VIAddVersionKey "ProductName" ${NOMBRE}
+VIAddVersionKey "Comments" "${COMENTARIO}"
+VIAddVersionKey "CompanyName" "EyPC"
+VIAddVersionKey "LegalCopyright" "© EyPC"
+VIAddVersionKey "FileVersion" "${VERSION}"
+
 Name ${NOMBRE}
-OutFile "${NOMBRE_CORTO}.${VERSION}.exe"
+OutFile "dist/instalador/${NOMBRE_CORTO}_${VERSION}.exe"
 InstallDir "$PROGRAMFILES64\${NOMBRE}"
 InstallDirRegKey HKLM "Software\${NOMBRE_CORTO}" "Install_Dir"
 RequestExecutionLevel admin
-#LicenseData "COPYING"
-#LicenseForceSelection radiobuttons "Acepto" "No acepto"
-
-#!insertmacro MUI_LICENSEPAGE_RADIOBUTTONS
-
-!insertmacro MUI_PAGE_WELCOME
-!insertmacro MUI_PAGE_LICENSE "COPYING"
-!insertmacro MUI_PAGE_DIRECTORY
-!insertmacro MUI_PAGE_INSTFILES
-!insertmacro MUI_PAGE_FINISH
-!insertmacro MUI_UNPAGE_WELCOME
-!insertmacro MUI_UNPAGE_CONFIRM
-!insertmacro MUI_UNPAGE_INSTFILES
-!insertmacro MUI_UNPAGE_FINISH
+LicenseData "COPYING"
+LicenseForceSelection radiobuttons "Acepto" "No acepto"
 
-#Page license
-#Page directory
-#Page instfiles
-#UninstPage uninstConfirm
-#UninstPage instfiles
+Page license
+Page directory
+Page instfiles
+UninstPage uninstConfirm
+UninstPage instfiles
 
 Section "Install"
   SetShellVarContext all
   SectionIn RO
   SetOutPath $INSTDIR
-  File /oname=z80.exe "dist\z80\z80-win_x64.exe"
+  File /oname=${NOMBRE_CORTO}.exe "dist\z80\z80-win_x64.exe"
   File "dist\z80\resources.neu"
   File "dist\z80\WebView2Loader.dll"
   File /oname=COPYING.txt "COPYING"
-#  File "doc/*.*"
-  WriteRegStr HKLM SOFTWARE\EmuladorZ80 "Install_Dir" "$INSTDIR"
+  WriteRegStr HKLM SOFTWARE\${NOMBRE_CORTO} "Install_Dir" "$INSTDIR"
   WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${NOMBRE_CORTO}" "DisplayName" "${NOMBRE}"
   WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${NOMBRE_CORTO}" "UninstallString" '"$INSTDIR\uninstall.exe"'
   WriteRegDWORD HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${NOMBRE_CORTO}" "NoModify" 1
   WriteRegDWORD HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${NOMBRE_CORTO}" "NoRepair" 1
   WriteUninstaller "$INSTDIR\uninstall.exe"
-  CreateShortcut "$SMPROGRAMS\${NOMBRE}.lnk" "$INSTDIR\z80.exe" "" "$INSTDIR\z80.exe" 0
-  CreateShortcut "$DESKTOP\${NOMBRE}.lnk" "$INSTDIR\z80.exe" "" "$INSTDIR\z80.exe" 0
+  CreateShortcut "$SMPROGRAMS\${NOMBRE}.lnk" "$INSTDIR\${NOMBRE_CORTO}.exe" "" "$INSTDIR\${NOMBRE_CORTO}.exe" 0
+  CreateShortcut "$DESKTOP\${NOMBRE}.lnk" "$INSTDIR\${NOMBRE_CORTO}.exe" "" "$INSTDIR\${NOMBRE_CORTO}.exe" 0
 SectionEnd
 
 Section "Uninstall"
@@ -55,8 +50,6 @@ Section "Uninstall"
   Delete $INSTDIR\WebView2Loader.dll
   Delete $INSTDIR\COPYING.txt
   Delete $INSTDIR\uninstall.exe
-#  Delete "$INSTDIR\docs\*"
-  Delete "$SMPROGRAMS\YOURPROGRAM\${NOMBRE}.lnk"
-#  RMDir "$INSTDIR\docs"
+  Delete "$SMPROGRAMS\${NOMBRE}.lnk"
   RMDir "$INSTDIR"
 SectionEnd

neutralino.config.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/neutralinojs/neutralinojs/main/schemas/neutralino.config.schema.json",
   "applicationId": "xyz.campanita.z80",
-  "version": "1.0.0",
+  "version": "1.0",
   "defaultMode": "window",
   "port": 0,
   "documentRoot": "/public/",
@@ -20,7 +20,7 @@
   ],
   "modes": {
     "window": {
-      "title": "Emulador z80",
+      "title": "RetroZ80Simulator",
       "width": 1200,
       "height": 700,
       "minWidth": 400,

preparar.sh

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+set -o pipefail
+IFS=$'\n\t'
+
+if [[ "dependencias" == "$1" || "todo" == "$1" ]]; then
+    echo "* Comprobando dependencias..."
+    makensis -VERSION > /dev/null
+    if [[ 0 == "$?" ]]; then
+        echo "nsis está instalado"
+    else
+        echo "nsis no está instalado"
+    fi
+    neu version > /dev/null
+    if [[ 0 == "$?" ]]; then
+        echo "neutralino está instalado"
+    else
+        echo "neutralino no está instalado"
+    fi
+    gcab --version > /dev/null
+    if [[ 0 == "$?" ]]; then
+        echo "gcab está instalado"
+    else
+        echo "gcab no está instalado"
+    fi
+fi
+
+if [[ "versionar" == "$1" || "todo" == "$1" ]]; then
+    echo "* Modificando versión a $2..."
+    sed -i -E "s/(.+<meta name=\"versionNumero\" content=\").*(\".+)/\1$2\2/" public/index.html
+    sed -i -E "s/(.+<meta name=\"versionFecha\" content=\").*(\".+)/\1$(date --utc)\2/" public/index.html
+    sed -i -E "s/(.+\"version\": \").*(\",)/\1$2\2/" neutralino.config.json
+fi
+
+if [[ "compilar" == "$1" || "todo" == "$1" ]]; then
+    echo "* Compilando..."
+    neu build
+fi
+
+if [[ "instalador" == "$1" || "todo" == "$1" ]]; then
+    echo "* Generando instaladores..."
+    mkdir -p dist/instalador
+    echo "makensis instalador.nsi -DVERSION=$2"
+    sed "3 a \!define VERSION $2" < instalador.nsi | makensis -
+fi
+
+if [[ "portable" == "$1" || "todo" == "$1" ]]; then
+    echo "* Generando portable..."
+    mkdir -p dist/portable
+    gcab -n -c dist/portable/z80_portable.cab dist/z80/z80-win_x64.exe dist/z80/resources.neu
+fi
+
+if [[ "limpiar" == "$1" ]]; then
+    echo "* Limpiando todo"
+    rm -r dist/*
+fi

public/icon.png

@@ -3,15 +3,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xmlns:l="https://campanita.xyz/ns/log" xml:lang="es" role="application">
     <head>
         <title>$nombre_app</title>
-        <meta name="versionNumero" content="%%versionNumero%%" />
-        <meta name="versionFecha" content="%%versionFecha%%" />
-        <meta name="versionCommit" content="%%versionCommit%%" />
+        <meta name="versionNumero" content="1.0" />
+        <meta name="versionFecha" content="mié 14 jun 2023 13:25:39 UTC" />
         <link rel="stylesheet" type="text/css" href="iconos.css" />
         <link rel="stylesheet" type="text/css" href="estilos.css" />
         <link rel="stylesheet" type="text/css" href="hint.min.css" />
         <link rel="stylesheet" type="text/css" href="codemirror.min.css" />
-        <link rel="stylesheet" type="text/css" href="monokai.min.css" />
-        <link rel="icon" type="image/svg" href="icon.svg" />
+        <link rel="icon" type="image/png" href="icon.png" />
         <link rel="manifest" href="manifest.json" />
         <script src="neutralino.js"></script>
         <script src="codemirror.min.js"></script>
@@ -625,13 +623,12 @@ <h2>$r_reg</h2>
         <dialog id="dlgAcercaDe" data-botones="a"><form method="dialog">
             <div id="dlgAcercaDeEsque">
                 <figure>
-                    <img src="icon.svg" alt="$dlg_acercade_iconode" />
+                    <img src="icon.png" width="200" alt="$dlg_acercade_iconode" />
                     <figcaption>$nombre_app</figcaption>
                 </figure>
                 <dl class="natural">
                     <dt>$dlg_acercade_version</dt><dd>%version</dd>
                     <dt>$dlg_acercade_fecha</dt><dd>%fecha</dd>
-                    <dt>$dlg_acercade_commit</dt><dd>%commit</dd>
                     <dt>$dlg_acercade_sistema</dt><dd>%sistema</dd>
                     <dt>Neutralino</dt><dd>%neu</dd>
                     <dt>$dlg_acercade_ua</dt><dd>%ua</dd>

public/icon.svg

@@ -1,22 +1,17 @@
 {
-  "name": "Emulador Z80",
+  "name": "RetroZ80Simulator",
   "short_name": "Z80",
   "start_url": ".",
   "categories": [ "utilities", "development", "education" ],
   "display": "standalone",
   "background_color": "#fff",
-  "description": "Emulador y ensamblador de un microprocesador Zilog Z80.",
+  "description": "Ensamblador y emulador libre del microprocesador Zilog Z80.",
   "orientation": "landscape",
   "icons": [
     {
       "src": "icon.png",
       "sizes": "64x64",
       "type": "image/png"
-    },
-    {
-      "src": "icon.svg",
-      "sizes": "any",
-      "type": "image/svg"
     }
   ]
 }