~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 Nix with Flake support installed on your machine.

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

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. Install the project dependencies

   If you have direnv installed, simply allow the environment:

   direnv allow

   Otherwise, you can use nix-shell to enter the environment:

   nix-shell --max-jobs $(nproc) # Linux / Windows (WSL)
   nix-shell --max-jobs $(sysctl -n hw.ncpu) # macOS

3. Build the project

   just build

4. Run the project

   just run <package_name>

Project Structure

KiwiCPP/
├── .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 Kaweees/kiwiCPP 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.