About Build

Directory build contains two different kinds of environments.

  • linux:

    Linux-based build environments

  • windows:

    Windows-based build environments

Existing Environments

Information on several existing environments is listed below.

linux/xkmsc

  • Function

    1. generate and run executable file xkmsc under Linux OS

  • Pre-Request

    item

    my version

    gcc, g++

    9.3.0

    Make

    4.2.1

    cmake

    3.16.3

  • Content

    item

    description

    build.sh

    build script

    run.sh

    (single-)run script

  • Usage

    In the WSL environment, change the directory to build/linux/xkmsc,
    then you can

    1. create a building environment with

      ./build.sh

      then you will get

      ../_images/buildLinux_Usage1.png

    2. generate executable file xkmsc with

      make

      then you will get

      ../_images/buildLinux_Usage2.png

    3. run executable file xkmsc (with a given configuration setting) with

      ./xkmsc -c ../../../script/run/runXkmsc/xkmsc.cfg

      then you will get

      ../_images/buildLinux_Usage3.png
    4. Sure, to run with a different configuration setting,
      you can either change the contents of configuration file xkmsc.cfg or overwrite them through the CLI (command-line interface).
      For example,
      ./xkmsc -c ../../../script/run/runXkmsc/xkmsc.cfg --numFrame 3
      ../_images/buildLinux_Usage4a.png
      Besides, I have created a (single-)run script run.sh which would execute the above steps one by one.
      Build parameters can be passed through -B “…”;
      Run parameters can be passed through -R “…”.
      For example,
      ./run.sh -R "--numFrame 5"
      ../_images/buildLinux_Usage4b.png

windows/xkmsc

  • Function

    1. generate and run executable file xkmsc under Windows OS

  • Pre-Request

    item

    my version

    CMake

    3.21.0

    Visual Studio

    2017-15.9.37

  • Content

    item

    description

    build_2017.dat

    VS_2017 build script

    build_2019.dat

    VS_2019 build script

  • Usage

    In Windows Explorer, change the directory to build/windows/xkmsc,
    then you can
    1. double click the corresponding build.bat to create a building environment
      (choose build_2017.bat if Visual Studio 2017 is installed)
      (choose build_2019.bat if Visual Studio 2019 is installed)
      ../_images/buildWindows_Usage1.png

    2. open solution file xkmsc.sln

      ../_images/buildWindows_Usage2.png

    3. right click on solution xkmsc and set it as the startup item

      ../_images/buildWindows_Usage3.png

    4. right click on solution xkmsc and click properties, then add

      -c ../../../script/run/runXkmsc/xkmsc.cfg
      to the command-line parameter
      (both slash and backslash can be recognized)
      ../_images/buildWindows_Usage4a.png ../_images/buildWindows_Usage4b.png

    5. click button Start or press key F5 to generate executable file xkmsc and run it with the given configuration setting

      ../_images/buildWindows_Usage5.png