Getting started

Clone and configure

To clone and configure this project, use the following steps:

  1. Clone the custom target image repo from GitLab:

    git clone https://gitlab.com/qnx/custom-target-image-builds/repo.git
  2. Navigate into the project folder:

    cd repo
  3. Export the path to the qnxsoftwarecenter_clt executable (modify according to your installation location):

    export QSC_CLT_PATH=$HOME/qnx/qnxsoftwarecenter/qnxsoftwarecenter_clt
  4. Create a file called options_file and populate it with:

    -myqnx.user
    <username>
    -myqnx.password
    <password>

    Replace the placeholders with your qnx.com credentials.

    This file provides your credentials to QNX Software Center (QSC) to install required packages locally for the image build. Take care not to share this file with others or commit it to a fork of this project.

  5. Run the following command depending on your target:

    • Raspberry Pi 4 — make TARGET=rpi4
    • Raspberry Pi 5 — make TARGET=rpi5
    Note:
    • The first build can take 30 minutes or more.
    • A separate installation of the QNX Software Development Platform (SDP) is installed within the project folder. The separate SDP installation is also used to build the open-source projects integrated into the build.
    • Due to the size of asset packages and projects that are downloaded from the Internet, you'll need approximately 10 GB of free disk space.
    • During the build, you'll see output from the different integration, download, and build steps in each of the project subfolders as the build proceeds. This is normal and expected. Some of the steps seen in the initial build are skipped in later builds, because the required artifacts have been downloaded and unpacked in previous builds.
  6. If the build is successful, it produces an image file for your given target:

    • Raspberry Pi 4 — build/rpi4/rpi4.img
    • Raspberry Pi 5 — build/rpi5/rpi5.img

    If the image generation isn't successful, refer to the "Troubleshooting" section later in this chapter for more details.

Flashing the Image

You can flash the generated image file using the Raspberry Pi Imager. For more information, refer to the "Flashing the image to a micro SD card" section of the "Quick start target image (QSTI)" chapter.

Page updated: