From 2087f106811f9b60bbf2a071883f39aea9d6a39d Mon Sep 17 00:00:00 2001 From: Shaun Reed Date: Sat, 11 Mar 2023 20:23:25 -0500 Subject: [PATCH] README --- .github/workflows/all-builds.yml | 20 +++++++-------- README.md | 42 ++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+), 10 deletions(-) diff --git a/.github/workflows/all-builds.yml b/.github/workflows/all-builds.yml index 6da6c63..2596ad4 100644 --- a/.github/workflows/all-builds.yml +++ b/.github/workflows/all-builds.yml @@ -76,7 +76,7 @@ jobs: shell: bash run: cmake --build build/ --target package --config Release - - name: Package Qtk Library (DEB) + - name: Package Qtk (DEB) if: matrix.os == 'ubuntu-latest' shell: bash run: | @@ -87,11 +87,11 @@ jobs: if: matrix.os == 'ubuntu-latest' uses: actions/upload-artifact@v3 with: - name: qtk-${{ matrix.os }}-debian + name: qtk-app-${{ matrix.os }} path: | build/packages/*.deb - - name: Package Qtk Library (WIN) + - name: Package Qtk (WIN) if: matrix.os == 'windows-latest' shell: bash run: | @@ -102,11 +102,11 @@ jobs: if: matrix.os == 'windows-latest' uses: actions/upload-artifact@v3 with: - name: qtk-${{ matrix.os }}-windows + name: qtk-app-${{ matrix.os }} path: | build/packages/*.exe - - name: Package Qtk Library (OSX) + - name: Package Qtk (OSX) if: matrix.os == 'macos-latest' shell: bash run: | @@ -117,14 +117,14 @@ jobs: if: matrix.os == 'macos-latest' uses: actions/upload-artifact@v3 with: - name: qtk-${{ matrix.os }}-macos + name: qtk-app-${{ matrix.os }} path: | build/packages/*.tar.gz - name: Upload Qtk install directory uses: actions/upload-artifact@v3 with: - name: qtk-${{ matrix.os }}-install + name: qtk-app-${{ matrix.os }}-install path: install/* # TODO: Enable after trimming resources. @@ -217,7 +217,7 @@ jobs: if: matrix.os == 'ubuntu-latest' uses: actions/upload-artifact@v3 with: - name: libqtk-${{ matrix.os }}-debian + name: libqtk-${{ matrix.os }} path: | build/packages/*.deb @@ -232,7 +232,7 @@ jobs: if: matrix.os == 'windows-latest' uses: actions/upload-artifact@v3 with: - name: qtk-${{ matrix.os }}-windows + name: qtk-${{ matrix.os }} path: | build/packages/*.exe @@ -247,7 +247,7 @@ jobs: if: matrix.os == 'macos-latest' uses: actions/upload-artifact@v3 with: - name: qtk-${{ matrix.os }}-macos + name: qtk-${{ matrix.os }} path: | build/packages/*.tar.gz diff --git a/README.md b/README.md index daa9283..a1302b0 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,48 @@ your system, **version 6.5.0** or later. Be sure to take note of the Qt6 installation directory, as we will need it to correctly set our `CMAKE_PREFIX_PATH` in the next steps. +If the build is configured with all options enabled, we can subsequently install +individual components as needed with cmake. + +```bash +cmake -B build-all/ -DQTK_BUILD_GUI=ON -DQTK_INSTALL_LIBRARY=ON -DQTK_INSTALL_PLUGINS=ON +``` + +```bash +# Install libqtk only +cmake --install build-all/ --prefix=$(pwd)/install --component libqtk +-- Install configuration: "Release" +-- Up-to-date: /home/shaun/Code/qtk/install/lib/cmake/Qtk/QtkConfig.cmake +-- Up-to-date: /home/shaun/Code/qtk/install/lib/cmake/Qtk/QtkConfigVersion.cmake +-- Up-to-date: /home/shaun/Code/qtk/install/lib/cmake/Qtk/QtkTargets.cmake +-- Up-to-date: /home/shaun/Code/qtk/install/lib/cmake/Qtk/QtkTargets-release.cmake +-- Up-to-date: /home/shaun/Code/qtk/install/lib/static/libqtk_library.a +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/camera3d.h +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/input.h +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/meshrenderer.h +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/model.h +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/modelmesh.h +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/object.h +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/qtkapi.h +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/qtkiostream.h +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/qtkiosystem.h +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/scene.h +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/shape.h +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/skybox.h +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/texture.h +-- Up-to-date: /home/shaun/Code/qtk/install/include/qtk/transform3D.h + +# Install Qtk widget collection to use Qt Designer +cmake --install build-all/ --prefix=$(pwd)/install --component collection +-- Install configuration: "Release" +-- Up-to-date: /home/shaun/Qt/6.5.0/gcc_64/../../Tools/QtCreator/lib/Qt/lib/libqtk_library.a +-- Up-to-date: /home/shaun/Qt/6.5.0/gcc_64/../../Tools/QtCreator/lib/Qt/lib/libqtk_plugin_library.a +-- Up-to-date: /home/shaun/Qt/6.5.0/gcc_64/../../Tools/QtCreator/lib/Qt/plugins/designer/libqtk_collection.so + +# Install Qtk desktop application (output removed) +cmake --install build-all/ --prefix=$(pwd)/install --component qtk +``` + #### Qtk GUI Once Qt6 is installed, to build and run `qtk` on Ubuntu -