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

  • Dependency

    item

    my version

    gcc, g++

    11.4.0

    Make

    4.3

    cmake

    3.22.1

  • Content

    item

    description

    build.sh

    build script

    run.sh

    (single-)run script

  • Usage

    In WSL environment, change 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 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 (Optional)

To Be Updated

linux/xkcalc

almost the same with xkmsc