Skip to content

Latest commit

 

History

History
81 lines (47 loc) · 2.83 KB

README.md

File metadata and controls

81 lines (47 loc) · 2.83 KB

TinyDIP

Tiny Digital Image Processing Library is a C++ library designed with C++20 syntax.

Note: The implementation in this repository is under experimental purpose. The condition of requirment for development environment, library dependencies, even the used C++ language version may be updated.

Environment Requirment

Both std::ranges and concepts are widely used in TinyDIP library. C++ compiler support information could be checked with https://en.cppreference.com/w/cpp/compiler_support#cpp20. The suggested compiler (tested, minimum) version are listed as below.

  • GCC: g++-11

  • MSVC: MSVC 19.24 (Visual Studio 2019 Update 4, Visual Studio 2019 version 16.4)

Build Configuration & Process

Linux & MacOS

TinyDIP library could be built with CMake as the following commands:

  1. Create ./build folder:

    mkdir build
  2. Config project

    cmake -B -S .
    cmake -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON -DCMAKE_C_COMPILER=/usr/bin/gcc -DCMAKE_CXX_COMPILER=/usr/bin/g++ -S . -B ./build    #  specify CMAKE_C_COMPILER and CMAKE_CXX_COMPILER flags
    • integrated with vcpkg toolchain
    cmake -B ./build -DCMAKE_TOOLCHAIN_FILE=../../vcpkg/scripts/buildsystems/vcpkg.cmake -S .
    cmake -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON -DCMAKE_C_COMPILER=/usr/bin/gcc -DCMAKE_CXX_COMPILER=/usr/bin/g++ -S . -B ./build    #  specify CMAKE_C_COMPILER and CMAKE_CXX_COMPILER flags
  3. Build project

    cmake --build ./build

    If the parallel build process is prefered, --parallel flag can be added. However, if you want to build in parallel, ensure the memory is large enough. On the other hand, if the verbose information is needed, --verbose flag can be added.

    cmake --build ./build --parallel --verbose
  4. Run the built execution file

    After the building process as above, the built execution files can be checked under ./build/ folder. The built execution file TinyDIP can be run with the following command:

    ./build/TinyDIP

Windows

Code Review