candie.kit 1.2.8

A CLI Build tool for C/C++ Projects

Candie.kit

A Simple C/C++ Build tool.
It Uses Zig as a drop-in compiler for compiling .c and .cpp files.

List of contents

• Installation
• Getting started
• Documentation

Installation

Candie.kit is is available on PyPI so it can be installed with this command.

pip install candie.kit

candie CLI

After installation you can run this command to get help.

candie . --help

Getting started

Every project must contain a Build Instruction file, Named Candie.build and this file should always be placed in the project root directory.

project/
├── main.c
├── greet.c
└── Candie.build

So create this file for your project. The Candie.build file can contain sections of code.

A Section can be created like this [SECTION_NAME] section name should be UPPERCASE.

[SETUP] is a required section.

Example Candie.build file 👇️

[SETUP]

PROJ_NAME = 'your_project_name'

project(
    name = PROJ_NAME, 
    language = C, 
)


[BUILD]

executable(
    name = PROJ_NAME,
    './main.c',
    './greet.c'
).create()

You can either provide the source file paths manually or use the grab_sources() function and provide the directory path of the src files.

Call the create() method to create the executable, You can provide .create(debug = True) to add debugging symbols to the executable.

finally, run this command to execute the build section.

candie build

This will create a executable named 'your_project_name'

Documentation

• SETUP section
• Generators
• InBuilt functions

License

This project is licensed under the Apache 2.0 License.

Made with 🧡 by Yash Tajne