README.md

~KiwiCPP

A template for creating C++ header-only libraries accelerated with CUDA/Apple Metal

Built With

Preview

Getting Started

Prerequisites

Before attempting to build this project, make sure you have GNU Make, and CMake installed on your machine.

Additionally, if you wish to utilize the GPU acceleration features, you will need to have CUDA Toolkit or Apple Metal installed on your machine.

you will need a C++ compiler that supports C++13, and a CUDA compatible GPU if you wish to use the CUDA acceleration features.

Installation

To get a local copy of the project up and running on your machine, follow these simple steps:

1. Clone the project repository

   git clone https://github.com/Kaweees/KiwiCPP.git
   cd KiwiCPP

2. Create a fresh build directory and navigate to it

   rm -rf build
   mkdir build
   cd build

3. Configure the build system

   # Use for debugging
   clear && cmake -S .. -B . -DCMAKE_BUILD_TYPE=Debug
   # Use for releases
   clear && cmake -S .. -B . -DCMAKE_BUILD_TYPE=Release

4. Build the project

   cmake --build ..

Project Structure

graphics/
├── .github/                       - GitHub Actions CI/CD workflows
├── include/                       - project header files
├── src/                           - project source files
│   └── main.c                     - Entry point, main function
├── CMakeLists.txt                 - CMake build script
├── LICENSE                        - project license
└── README.md                      - you are here

License

The source code for my website is distributed under the terms of the GNU General Public License v3.0, as I firmly believe that collaborating on free and open-source software fosters innovations that mutually and equitably beneficial to both collaborators and users alike. See LICENSE for details and more information.