feat: complete Phase 5 packaging and release readiness for Core85 v1.0.0

- add CMake install rules for the GUI app, core library, headers, docs, and sample programs
- add CPack packaging with release archive generation and SHA256 checksum output
- add release notes and LGPL redistribution notices
- refresh README and runbook to match the shipped v1.0 workflow
- add CI matrix coverage for build, test, and package smoke checks on macOS, Ubuntu, and Windows
- verify full test suite stays green with 411 passing tests

Author: Brxj19

.github/workflows/ci.yml

@@ -0,0 +1,64 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build-test-package:
+    name: ${{ matrix.os }} / ${{ matrix.build_type }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-22.04
+            build_type: Release
+          - os: macos-13
+            build_type: Release
+          - os: windows-2022
+            build_type: Release
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Linux system packages
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libgl1-mesa-dev
+
+      - name: Install Qt
+        uses: jurplel/install-qt-action@v4
+        with:
+          version: '6.7.2'
+          modules: 'qtbase'
+          cache: true
+
+      - name: Configure
+        run: >
+          cmake -S . -B build -G Ninja
+          -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
+          -DCORE85_BUILD_GUI=ON
+
+      - name: Build
+        run: cmake --build build --config ${{ matrix.build_type }}
+
+      - name: Test
+        run: ctest --test-dir build --output-on-failure -C ${{ matrix.build_type }}
+
+      - name: Package Smoke Test
+        run: cmake --build build --target package --config ${{ matrix.build_type }}
+
+      - name: Upload Package Artefacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: core85-${{ runner.os }}
+          path: |
+            build/*.dmg
+            build/*.zip
+            build/*.tar.gz

.gitignore

@@ -42,6 +42,14 @@ qrc_*.cpp
 /core85_tests
 /bin/
 /lib/
+/stage/
+/dist/
+
+# Package artefacts
+*.dmg
+*.tar.gz
+*.zip
+*.sha256
 
 # Ninja and Make artifacts
 .ninja_deps

CMakeLists.txt

@@ -1,6 +1,8 @@
 cmake_minimum_required(VERSION 3.25)
 
-project(Core85 VERSION 0.1.0 LANGUAGES CXX)
+project(Core85 VERSION 1.0.0 LANGUAGES CXX)
+
+include(GNUInstallDirs)
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
@@ -9,6 +11,34 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 option(CORE85_BUILD_GUI "Build the Qt GUI application" ON)
 option(CORE85_BUILD_TESTS "Build the GTest test suite" ON)
 
+set(CORE85_QT_DEPLOY_OPTIONS "")
+if(APPLE)
+    foreach(path
+            /opt/homebrew/lib
+            /opt/homebrew/Frameworks
+            /usr/local/lib
+            /usr/local/Frameworks)
+        if(EXISTS "${path}")
+            list(APPEND CORE85_QT_DEPLOY_OPTIONS "-libpath=${path}")
+        endif()
+    endforeach()
+endif()
+
+set(CORE85_CORE_HEADERS
+    src/core/assembler.h
+    src/core/cpu.h
+    src/core/io_bus.h
+    src/core/memory.h
+    src/core/span.h
+)
+
+set(CORE85_DOC_FILES
+    README.md
+    runbook.md
+    NOTICES.md
+    RELEASE_NOTES_v1.0.md
+)
+
 add_library(core85_lib STATIC
     src/core/assembler.cpp
     src/core/cpu.cpp
@@ -18,7 +48,8 @@ add_library(core85_lib STATIC
 
 target_include_directories(core85_lib
     PUBLIC
-        ${CMAKE_CURRENT_SOURCE_DIR}/src
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src>
+        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
 )
 
 if(MSVC)
@@ -27,7 +58,23 @@ else()
     target_compile_options(core85_lib PRIVATE -Wall -Wextra -Wpedantic)
 endif()
 
+install(TARGETS core85_lib
+    EXPORT Core85Targets
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+)
+
+install(FILES ${CORE85_CORE_HEADERS}
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/core85/core
+)
+
+set(CORE85_DEPLOY_SCRIPT "")
+
 if(CORE85_BUILD_GUI)
+    if(APPLE)
+        set(QT_INTERNAL_SKIP_DEPLOYMENT ON)
+    endif()
+
     find_package(Qt6 COMPONENTS Widgets QUIET)
 
     if(Qt6_FOUND)
@@ -51,6 +98,12 @@ if(CORE85_BUILD_GUI)
             AUTOMOC ON
             AUTOUIC ON
             AUTORCC ON
+            MACOSX_BUNDLE ON
+            MACOSX_BUNDLE_BUNDLE_NAME "Core85"
+            MACOSX_BUNDLE_GUI_IDENTIFIER "org.core85.app"
+            MACOSX_BUNDLE_BUNDLE_VERSION ${PROJECT_VERSION}
+            MACOSX_BUNDLE_SHORT_VERSION_STRING ${PROJECT_VERSION}
+            WIN32_EXECUTABLE ON
         )
 
         target_link_libraries(core85_gui
@@ -59,6 +112,79 @@ if(CORE85_BUILD_GUI)
                 core85_lib
         )
 
+        if(APPLE)
+            find_program(CORE85_MACDEPLOYQT_EXECUTABLE
+                NAMES macdeployqt
+                HINTS
+                    "${Qt6_DIR}/../../../bin"
+                    "${Qt6_DIR}/../../../../bin"
+            )
+            find_program(CORE85_QTPATHS_EXECUTABLE
+                NAMES qtpaths6 qtpaths
+                HINTS
+                    "${Qt6_DIR}/../../../bin"
+                    "${Qt6_DIR}/../../../../bin"
+            )
+
+            set(CORE85_QT_PLUGIN_DIR "")
+            if(CORE85_QTPATHS_EXECUTABLE)
+                execute_process(
+                    COMMAND "${CORE85_QTPATHS_EXECUTABLE}" --plugin-dir
+                    OUTPUT_VARIABLE CORE85_QT_PLUGIN_DIR
+                    OUTPUT_STRIP_TRAILING_WHITESPACE
+                )
+            endif()
+
+            set(CORE85_QCOCOA_PLUGIN "")
+            if(CORE85_QT_PLUGIN_DIR)
+                find_file(CORE85_QCOCOA_PLUGIN
+                    NAMES libqcocoa.dylib
+                    PATHS "${CORE85_QT_PLUGIN_DIR}/platforms"
+                    NO_DEFAULT_PATH
+                )
+            endif()
+        endif()
+
+        install(TARGETS core85_gui
+            BUNDLE DESTINATION .
+            RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+        )
+
+        if(APPLE)
+            if(CORE85_MACDEPLOYQT_EXECUTABLE AND CORE85_QCOCOA_PLUGIN)
+                set(CORE85_DEPLOY_SCRIPT "${CMAKE_CURRENT_BINARY_DIR}/core85_deploy.cmake")
+                set(CORE85_DEPLOY_TOOL_COMMAND
+                    "execute_process(\n"
+                    "    COMMAND \"${CORE85_MACDEPLOYQT_EXECUTABLE}\" \"core85_gui.app\" \"-no-plugins\" \"-always-overwrite\"")
+                foreach(option IN LISTS CORE85_QT_DEPLOY_OPTIONS)
+                    string(APPEND CORE85_DEPLOY_TOOL_COMMAND " \"${option}\"")
+                endforeach()
+                string(APPEND CORE85_DEPLOY_TOOL_COMMAND
+                    "\n    WORKING_DIRECTORY \"\${CMAKE_INSTALL_PREFIX}\"\n"
+                    "    COMMAND_ERROR_IS_FATAL ANY\n"
+                    ")\n")
+
+                file(GENERATE OUTPUT "${CORE85_DEPLOY_SCRIPT}" CONTENT
+"${CORE85_DEPLOY_TOOL_COMMAND}
+file(MAKE_DIRECTORY \"\${CMAKE_INSTALL_PREFIX}/core85_gui.app/Contents/PlugIns/platforms\")
+file(COPY \"${CORE85_QCOCOA_PLUGIN}\"
+     DESTINATION \"\${CMAKE_INSTALL_PREFIX}/core85_gui.app/Contents/PlugIns/platforms\")
+")
+            else()
+                qt_generate_deploy_app_script(
+                    TARGET core85_gui
+                    OUTPUT_SCRIPT CORE85_DEPLOY_SCRIPT
+                    NO_UNSUPPORTED_PLATFORM_ERROR
+                )
+            endif()
+        else()
+            qt_generate_deploy_app_script(
+                TARGET core85_gui
+                OUTPUT_SCRIPT CORE85_DEPLOY_SCRIPT
+                NO_UNSUPPORTED_PLATFORM_ERROR
+            )
+        endif()
+
         add_custom_target(run
             COMMAND $<TARGET_FILE:core85_gui>
             DEPENDS core85_gui
@@ -92,10 +218,10 @@ if(CORE85_BUILD_TESTS)
         tests/test_data_transfer.cpp
         tests/test_io.cpp
         tests/test_instruction_matrix.cpp
+        tests/test_interrupts.cpp
         tests/test_logical.cpp
         tests/test_memory.cpp
         tests/test_stack.cpp
-        tests/test_interrupts.cpp
     )
 
     target_link_libraries(core85_tests
@@ -121,3 +247,63 @@ if(CORE85_BUILD_TESTS)
         COMMENT "Building and running the Core85 test suite"
     )
 endif()
+
+install(FILES ${CORE85_DOC_FILES}
+    DESTINATION ${CMAKE_INSTALL_DOCDIR}
+)
+
+install(DIRECTORY docs/
+    DESTINATION ${CMAKE_INSTALL_DOCDIR}/docs
+    FILES_MATCHING
+    PATTERN "*.docx"
+)
+
+install(DIRECTORY tests/asm/
+    DESTINATION ${CMAKE_INSTALL_DATADIR}/core85/examples
+    FILES_MATCHING
+    PATTERN "*.asm"
+)
+
+install(EXPORT Core85Targets
+    FILE Core85Targets.cmake
+    NAMESPACE Core85::
+    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Core85
+)
+
+if(CORE85_DEPLOY_SCRIPT)
+    install(SCRIPT ${CORE85_DEPLOY_SCRIPT})
+endif()
+
+set(CPACK_PACKAGE_NAME "Core85")
+set(CPACK_PACKAGE_VENDOR "Core85 Engineering Team")
+set(CPACK_PACKAGE_DESCRIPTION_SUMMARY
+    "Cross-platform Intel 8085 emulator and educational simulator")
+set(CPACK_PACKAGE_VERSION ${PROJECT_VERSION})
+set(CPACK_PACKAGE_INSTALL_DIRECTORY "Core85")
+set(CPACK_PACKAGE_FILE_NAME
+    "Core85-${PROJECT_VERSION}-${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR}")
+set(CPACK_MONOLITHIC_INSTALL ON)
+set(CPACK_PACKAGE_CHECKSUM SHA256)
+set(CPACK_VERBATIM_VARIABLES YES)
+set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README.md")
+set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/NOTICES.md")
+
+if(APPLE)
+    set(CPACK_GENERATOR "ZIP")
+elseif(WIN32)
+    set(CPACK_GENERATOR "ZIP")
+else()
+    set(CPACK_GENERATOR "TGZ")
+endif()
+
+set(CPACK_SOURCE_GENERATOR "TGZ;ZIP")
+set(CPACK_SOURCE_IGNORE_FILES
+    "/build/"
+    "/build-gui/"
+    "/\\.git/"
+    "/\\.idea/"
+    "/\\.vscode/"
+    "\\.DS_Store"
+)
+
+include(CPack)

NOTICES.md

@@ -0,0 +1,35 @@
+# Core85 Notices
+
+## Project Notice
+
+Core85 is distributed as a C++17 application and library with a Qt 6 desktop frontend.
+
+## Qt Notice
+
+Core85 is intended to use the Qt LGPL edition with dynamic linking for redistribution scenarios that require LGPL compliance. When shipping binary packages, bundle only the Qt runtime pieces required by the application.
+
+Redistributors are responsible for:
+
+- complying with the applicable Qt license terms
+- preserving Qt copyright and license notices
+- making any required reverse-linking or relinking rights available when LGPL obligations apply
+
+## Third-Party Components
+
+### Qt 6
+
+- usage: GUI framework and runtime deployment support
+- upstream: The Qt Company and contributors
+- expected license path: refer to the installed Qt distribution used to build the package
+
+### GoogleTest
+
+- usage: development and test-only dependency
+- upstream: GoogleTest contributors
+- note: not required for end-user runtime packages
+
+## Packaging Guidance
+
+- keep Qt runtime deployment minimal
+- do not bundle development-only tools into end-user packages
+- verify package contents and package size during release smoke tests