Merge pull request #92 from josevcm/develop

switch to NSIS installer and add portable package

Author: josevcm

.github/workflows/cmake-build.yml

@@ -86,10 +86,9 @@ jobs:
           echo "ninja-dir=${{ github.workspace }}/tools/ninja" >> "$GITHUB_OUTPUT"
           echo "cmake-dir=${{ github.workspace }}/tools/cmake_64" >> "$GITHUB_OUTPUT"
           echo "mingw-dir=${{ github.workspace }}/tools/mingw1310_64" >> "$GITHUB_OUTPUT"
-          echo "installer-dir=${{ github.workspace }}/tools/QtInstallerFramework/4.7" >> "$GITHUB_OUTPUT"
           echo "package-dir=${{ github.workspace }}/build/installer/package" >> "$GITHUB_OUTPUT"
-          echo "package-data-dir=${{ github.workspace }}/build/installer/package/org.josevcm.nfc-lab/data" >> "$GITHUB_OUTPUT"
-          echo "package-meta-dir=${{ github.workspace }}/build/installer/package/org.josevcm.nfc-lab/meta" >> "$GITHUB_OUTPUT"
+          echo "installer-data-dir=${{ github.workspace }}/build/installer/data" >> "$GITHUB_OUTPUT"
+          echo "installer-meta-dir=${{ github.workspace }}/build/installer/meta" >> "$GITHUB_OUTPUT"
           echo "cpu-count=4" >> "$GITHUB_OUTPUT"
 
       - name: 'Cache dependencies'
@@ -104,12 +103,16 @@ jobs:
       - name: 'Install dependencies'
         if: steps.cache-dependencies.outputs.cache-hit != 'true'
         run: |
+          # install Qt and build tools
           choco install aqt -y --no-progress -r
           aqt install-qt windows desktop 6.7.2 win64_mingw --outputdir ${{ github.workspace }}/qt
           aqt install-tool windows desktop tools_mingw1310 qt.tools.win64_mingw1310 --outputdir ${{ github.workspace }}
           aqt install-tool windows desktop tools_cmake qt.tools.cmake --outputdir ${{ github.workspace }}
           aqt install-tool windows desktop tools_ninja qt.tools.ninja --outputdir ${{ github.workspace }}
-          aqt install-tool windows desktop tools_ifw qt.tools.ifw.47 --outputdir ${{ github.workspace }}
+
+      - name: 'Install NSIS'
+        run: |
+          choco install nsis.portable -y --no-progress -r
 
       - name: 'Build project'
         run: |
@@ -130,25 +133,23 @@ jobs:
       - name: 'Create installer'
         run: |
           # create installer folders
-          New-Item -Force -ItemType "directory" -Path ${{ steps.strings-windows.outputs.package-data-dir }}
-          New-Item -Force -ItemType "directory" -Path ${{ steps.strings-windows.outputs.package-meta-dir }}
+          New-Item -Force -ItemType "directory" -Path ${{ steps.strings-windows.outputs.installer-data-dir }}
+          New-Item -Force -ItemType "directory" -Path ${{ steps.strings-windows.outputs.installer-meta-dir }}
           
           # copy executable and libraries
-          Copy-Item -Force ${{ steps.strings-windows.outputs.build-dir }}/src/nfc-app/app-qt/nfc-lab.exe ${{ steps.strings-windows.outputs.package-data-dir }}
-          Copy-Item -Force ${{ steps.strings-windows.outputs.mingw-dir }}/bin/*.dll ${{ steps.strings-windows.outputs.package-data-dir }}
-          Copy-Item -Force ${{ github.workspace }}/dll/airspy/x86_64/bin/*.dll ${{ steps.strings-windows.outputs.package-data-dir }}
-          Copy-Item -Force ${{ github.workspace }}/dll/hydrasdr/x86_64/bin/*.dll ${{ steps.strings-windows.outputs.package-data-dir }}
-          Copy-Item -Force ${{ github.workspace }}/dll/openssl/x86_64/bin/*.dll ${{ steps.strings-windows.outputs.package-data-dir }}
-          Copy-Item -Force ${{ github.workspace }}/dll/rtlsdr/x86_64/bin/*.dll ${{ steps.strings-windows.outputs.package-data-dir }}
-          Copy-Item -Force ${{ github.workspace }}/dll/usb/x86_64/bin/*.dll ${{ steps.strings-windows.outputs.package-data-dir }}
-          
-          # copy drivers and firmware
-          Copy-Item -Force -Recurse ${{ github.workspace }}/dat/config ${{ steps.strings-windows.outputs.package-data-dir }}
-          Copy-Item -Force -Recurse ${{ github.workspace }}/dat/drivers ${{ steps.strings-windows.outputs.package-data-dir }}
-          Copy-Item -Force -Recurse ${{ github.workspace }}/dat/firmware ${{ steps.strings-windows.outputs.package-data-dir }}
+          Copy-Item -Force ${{ steps.strings-windows.outputs.build-dir }}/src/nfc-app/app-qt/nfc-lab.exe ${{ steps.strings-windows.outputs.installer-data-dir }}
+          Copy-Item -Force ${{ steps.strings-windows.outputs.mingw-dir }}/bin/*.dll ${{ steps.strings-windows.outputs.installer-data-dir }}
+          Copy-Item -Force ${{ github.workspace }}/dll/airspy/x86_64/bin/*.dll ${{ steps.strings-windows.outputs.installer-data-dir }}
+          Copy-Item -Force ${{ github.workspace }}/dll/hydrasdr/x86_64/bin/*.dll ${{ steps.strings-windows.outputs.installer-data-dir }}
+          Copy-Item -Force ${{ github.workspace }}/dll/openssl/x86_64/bin/*.dll ${{ steps.strings-windows.outputs.installer-data-dir }}
+          Copy-Item -Force ${{ github.workspace }}/dll/rtlsdr/x86_64/bin/*.dll ${{ steps.strings-windows.outputs.installer-data-dir }}
+          Copy-Item -Force ${{ github.workspace }}/dll/usb/x86_64/bin/*.dll ${{ steps.strings-windows.outputs.installer-data-dir }}
           
-          # copy installer resources
-          Copy-Item -Force ${{ steps.strings-windows.outputs.build-dir }}/installer/config/*.* ${{ steps.strings-windows.outputs.package-meta-dir }}
+          # copy drivers, firmware and installer resources
+          Copy-Item -Force -Recurse ${{ github.workspace }}/dat/config ${{ steps.strings-windows.outputs.installer-data-dir }}
+          Copy-Item -Force -Recurse ${{ github.workspace }}/dat/drivers ${{ steps.strings-windows.outputs.installer-data-dir }}
+          Copy-Item -Force -Recurse ${{ github.workspace }}/dat/firmware ${{ steps.strings-windows.outputs.installer-data-dir }}
+          Copy-Item -Force -Recurse ${{ github.workspace }}/dat/resources ${{ steps.strings-windows.outputs.installer-meta-dir }}
           
           # create deployment
           ${{ steps.strings-windows.outputs.qt-dir }}/bin/windeployqt `
@@ -157,20 +158,23 @@ jobs:
             --no-translations `
             --no-system-d3d-compiler `
             --no-opengl-sw `
-            ${{ steps.strings-windows.outputs.package-data-dir }}/nfc-lab.exe
-          
+            ${{ steps.strings-windows.outputs.installer-data-dir }}/nfc-lab.exe
+
+          # create portable package
+          Compress-Archive `
+            -Path ${{ steps.strings-windows.outputs.installer-data-dir }}/* `
+            -DestinationPath ${{ github.workspace }}/nfc-lab-${{ steps.strings-windows.outputs.build-version }}-x86_64-portable.zip
+
           # create installer
-          ${{ steps.strings-windows.outputs.installer-dir }}/bin/binarycreator `
-            --verbose `
-            -c ${{ steps.strings-windows.outputs.build-dir }}/installer/config/config.xml `
-            -p ${{ steps.strings-windows.outputs.package-dir }} `
-            nfc-lab-${{ steps.strings-windows.outputs.build-version }}-x86_64.exe
+          makensis ${{ steps.strings-windows.outputs.installer-meta-dir }}/script.nsi
 
       - name: 'Upload artifact'
         uses: actions/upload-artifact@v4
         with:
           name: windows-artifact
-          path: ${{ github.workspace }}/*.exe
+          path: |
+            ${{ github.workspace }}/*.exe
+            ${{ github.workspace }}/*.zip
 
   #
   # Create release job
@@ -230,17 +234,15 @@ jobs:
   # WinGet release job
   #
   winget-release:
-
     runs-on: windows-latest
     needs: create-release
-    if: github.ref_type == 'tag'
-
+#    if: github.ref_type == 'tag'
+    if: false
     steps:
-
       - name: 'WinGet Releaser'
         uses: vedantmgoyal9/winget-releaser@v2
         with:
           identifier: josevcm.nfc-lab
-          installers-regex: 'nfc-lab-.*-x86_64\.exe$'
+          installers-regex: 'nfc-lab-.*-x86_64-portable\.zip$'
           token: ${{ secrets.WINGET_TOKEN }}
           fork-user: josevcm

.github/workflows/flatpak-build.yml

@@ -1,18 +1,9 @@
-name: Flatpak CI
+name: Flatpak CI (DISABLED)
 
+# DISABLED: The Flatpak manifest (io.github.josevcm.nfc-laboratory.yml) now lives in the Flathub repository.
+# Flatpak builds are handled there instead of in this repository.
 on:
-  pull_request:
-    paths:
-      - 'io.github.josevcm.nfc-laboratory.yml'
-      - 'dat/flatpak/**'
-      - 'flatpak-build.yml'
-  push:
-    tags:
-      - '*' # any tag
-    paths:
-      - 'io.github.josevcm.nfc-laboratory.yml'
-      - 'dat/flatpak/**'
-      - 'flatpak-build.yml'
+  workflow_dispatch:
 
 jobs:
   validate-metadata:

.github/workflows/flatpak-update-check.yml

@@ -1,8 +1,8 @@
-name: Check Flatpak Updates
+name: Check Flatpak Updates (DISABLED)
 
+# DISABLED: The Flatpak manifest (io.github.josevcm.nfc-laboratory.yml) now lives in the Flathub repository.
+# Update checks should be done in that repository instead.
 on:
-  schedule:
-    - cron: '0 0 * * 0'  # Weekly on Sunday at midnight UTC
   workflow_dispatch:
 
 jobs:

.gitignore

@@ -4,6 +4,9 @@
 /run/
 src/nfc-app/app-qt/src/main/cpp/QtConfig.h
 /build
+/build-*
+*.exe
+*-x86_64-portable.zip
 /nfc-lab
 .flatpak-builder/
 build-dir/

CMakeLists.txt

@@ -5,7 +5,7 @@ list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 set(COMPANY "Jose Vicente Campos")
 set(PROGRAM_NAME "nfc-lab")
 set(ICON_FILE_PATH "../assets/app/rc/nfc-lab.ico")
-set(APP_TARGET_DIR "@HomeDir@/.${PROGRAM_NAME}")
+set(APP_TARGET_DIR "@HomeDir@/AppData/Local/josevcm/${PROGRAM_NAME}")
 
 if(NOT DEFINED BUILD_PROJECT_VERSION)
   set(BUILD_PROJECT_VERSION "0.0.0")
@@ -99,21 +99,32 @@ else ()
   message(STATUS  "librtlsdr not found, using local bundle in static mode")
 endif()
 
+#-------------------------------------------------------------------------------
+# find dependency mirisdr
+#-------------------------------------------------------------------------------
+find_package(libmirisdr)
+
+if(LIBMIRISDR_FOUND)
+  message(STATUS "libmirisdr: found and using dynamic link mode")
+  message(STATUS "  include: " ${LIBMIRISDR_INCLUDE})
+  message(STATUS "  library: " ${LIBMIRISDR_LIBRARY})
+  include_directories(${LIBMIRISDR_INCLUDE})
+else ()
+  message(STATUS  "libmirisdr not found, using local bundle in static mode")
+endif()
+
 #-------------------------------------------------------------------------------
 # configure files
 #-------------------------------------------------------------------------------
 
 if (WIN32)
 
-  # generate build scripts
+  # generate manual build scripts
   configure_file(${CMAKE_CURRENT_SOURCE_DIR}/dat/scripts/build-runenv.ps1.in ${CMAKE_CURRENT_BINARY_DIR}/build-runenv.ps1)
   configure_file(${CMAKE_CURRENT_SOURCE_DIR}/dat/scripts/build-installer.ps1.in ${CMAKE_CURRENT_BINARY_DIR}/build-installer.ps1)
 
-  # generate build scripts
-  configure_file(${CMAKE_CURRENT_SOURCE_DIR}/dat/installer/config.xml.in ${CMAKE_CURRENT_BINARY_DIR}/installer/config/config.xml)
-  configure_file(${CMAKE_CURRENT_SOURCE_DIR}/dat/installer/package.xml.in ${CMAKE_CURRENT_BINARY_DIR}/installer/config/package.xml)
-  configure_file(${CMAKE_CURRENT_SOURCE_DIR}/dat/installer/license.txt.in ${CMAKE_CURRENT_BINARY_DIR}/installer/config/license.txt)
-  configure_file(${CMAKE_CURRENT_SOURCE_DIR}/dat/installer/script.js.in ${CMAKE_CURRENT_BINARY_DIR}/installer/config/script.js)
+  # generate installer scripts
+  configure_file(${CMAKE_CURRENT_SOURCE_DIR}/dat/installer/script.nsi.in ${CMAKE_CURRENT_BINARY_DIR}/installer/meta/script.nsi)
 
 endif (WIN32)
 

FLATPAK.md

@@ -1,106 +1,47 @@
-# Flatpak Integration
+# Flatpak Distribution
 
-NFC Laboratory is available as a Flatpak package for Linux systems.
+NFC Laboratory is available as a Flatpak package on Flathub.
 
-## Quick Install (from Flathub)
-
-Once published on Flathub:
+## Install
 
 ```bash
 flatpak install flathub io.github.josevcm.nfc-laboratory
 flatpak run io.github.josevcm.nfc-laboratory
 ```
 
-## Local Build
-
-### Prerequisites
-
-```bash
-sudo apt install flatpak flatpak-builder
-flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
-flatpak install flathub org.kde.Platform//6.8 org.kde.Sdk//6.8
-```
-
-**Note:** Runtime version 6.8 is the current stable version. Check available versions:
-
-```bash
-flatpak remote-info flathub org.kde.Platform | grep Branch
-```
-
-### Build and Install
-
-```bash
-flatpak-builder --user --install --force-clean build-dir io.github.josevcm.nfc-laboratory.yml
-```
+## Hardware Access
 
-### Run
+USB access for SDR receivers and logic analyzers:
 
 ```bash
-flatpak run io.github.josevcm.nfc-laboratory
+sudo usermod -a -G plugdev $USER  # Add user to plugdev group
+# Install device-specific udev rules
+# Log out and back in
 ```
 
-## Validation
+## Configuration
 
-```bash
-# Standard validation
-appstreamcli validate --pedantic dat/flatpak/io.github.josevcm.nfc-laboratory.metainfo.xml
-desktop-file-validate dat/flatpak/io.github.josevcm.nfc-laboratory.desktop
+User data stored in: `~/.var/app/io.github.josevcm.nfc-laboratory/.nfc-lab/`
 
-# Flatpak-builder lint (optional, for Flathub submission)
-flatpak run --command=flatpak-builder-lint org.flatpak.Builder manifest io.github.josevcm.nfc-laboratory.yml
-flatpak run --command=flatpak-builder-lint org.flatpak.Builder appstream dat/flatpak/io.github.josevcm.nfc-laboratory.metainfo.xml
-```
+## Building Locally
 
-## Testing
+The project uses a universal build system that supports both normal and Flatpak builds:
 
 ```bash
-# Test flags
-flatpak run io.github.josevcm.nfc-laboratory --help
-flatpak run io.github.josevcm.nfc-laboratory --version
-
-# Check library dependencies
-flatpak run --command=sh io.github.josevcm.nfc-laboratory -c "ldd /app/bin/nfc-lab | grep 'not found'"
-
-# Build with local repository (for testing installation)
-flatpak-builder --force-clean --repo=repo build-dir io.github.josevcm.nfc-laboratory.yml
-flatpak --user remote-add --no-gpg-verify test-repo repo
-flatpak --user install test-repo io.github.josevcm.nfc-laboratory
+# Normal build (installs as 'nfc-lab')
+cmake -B build -DCMAKE_BUILD_TYPE=Release
+cmake --build build
 
-# Lint build artifacts (may show screenshot warnings - acceptable)
-flatpak run --command=flatpak-builder-lint org.flatpak.Builder builddir build-dir
-flatpak run --command=flatpak-builder-lint org.flatpak.Builder repo repo
+# Flatpak build (installs as 'io.github.josevcm.nfc-laboratory')
+cmake -B build -DCMAKE_BUILD_TYPE=Release -DFLATPAK_BUILD=ON
+cmake --build build
 ```
 
-## Hardware Access
-
-The Flatpak requires USB access for SDR receivers and logic analyzers:
-
-1. Add user to plugdev group:
-
-   ```bash
-   sudo usermod -a -G plugdev $USER
-   ```
-
-2. Install udev rules for your hardware (device-specific)
-
-3. Log out and log back in
+The Flatpak manifest is maintained in the [Flathub repository](https://github.com/flathub/io.github.josevcm.nfc-laboratory).
 
-## File Structure
+## Metadata Files
 
-- `io.github.josevcm.nfc-laboratory.yml` - Flatpak manifest
+Flatpak metadata is located in:
 - `dat/flatpak/io.github.josevcm.nfc-laboratory.metainfo.xml` - AppStream metadata
 - `dat/flatpak/io.github.josevcm.nfc-laboratory.desktop` - Desktop entry
-- `dat/flatpak/README.md` - Additional documentation
-
-## Configuration
-
-User configuration is stored in:
-
-```
-~/.var/app/io.github.josevcm.nfc-laboratory/.nfc-lab/
-```
-
-## Support
-
-For issues specific to the Flatpak package, please report at:
-<https://github.com/josevcm/nfc-laboratory/issues>
+- `src/nfc-app/app-qt/src/main/assets/app/rc/` - Files installed during build

cmake/Findlibmirisdr.cmake

@@ -0,0 +1,35 @@
+
+if (LIBMIRISDR_LIBRARY AND LIBMIRISDR_INCLUDE)
+    set(LIBMIRISDR_FOUND TRUE)
+else (LIBMIRISDR_LIBRARY AND LIBMIRISDR_INCLUDE)
+
+    find_path(LIBMIRISDR_INCLUDE
+            NAMES
+                mirisdr.h
+            PATHS
+                /usr/include
+                /usr/local/include
+                /opt/local/include
+            PATH_SUFFIXES
+                libmirisdr
+    )
+
+    find_library(LIBMIRISDR_LIBRARY
+            NAMES
+                mirisdr
+            PATHS
+                /usr/local/lib64
+                /opt/local/lib64
+                /usr/lib64
+                /usr/local/lib
+                /opt/local/lib
+                /usr/lib
+    )
+
+    if (LIBMIRISDR_INCLUDE AND LIBMIRISDR_LIBRARY)
+        set(LIBMIRISDR_FOUND TRUE)
+    else ()
+        set(LIBMIRISDR_LIBRARY "mirisdr")
+    endif ()
+
+endif (LIBMIRISDR_LIBRARY AND LIBMIRISDR_INCLUDE)

dat/flatpak/io.github.josevcm.nfc-laboratory.desktop

@@ -1,12 +1,10 @@
 [Desktop Entry]
 Type=Application
 Name=NFC Laboratory
-GenericName=NFC Signal and Protocol Analyzer
-Comment=NFC signal sniffer and protocol decoder using SDR receiver
+GenericName=NFC signal and protocol analyzer
+Comment=NFC signal and protocol analyzer using SDR receiver
 Exec=nfc-lab
 Terminal=false
 Icon=io.github.josevcm.nfc-laboratory
 Categories=Science;Engineering;
-Keywords=NFC;SDR;Radio;Protocol;Analyzer;SignalProcessing;ISO14443;ISO15693;RFID;
-StartupNotify=true
-StartupWMClass=nfc-lab
+Keywords=NFC;SDR;Radio;protocol analyzer;signal decoder;RTL-SDR;AirSpy;HydraSDR;ISO14443;ISO15693;ISO7816;RFID;smart card;