Skip to content

Quick Start

Quick Start Steps

Below is a quick overview of how to get started from Ceedling installation through running build tasks. Jump down just a teeny bit to see what the Ceedling command line looks like and navigate to all the documentation for the steps listed immediately below.

  1. Install Ceedling
  2. Create a project
  3. Use Ceedling to generate an example project, or
  4. Add a Ceedling project file to the root of an existing project, or
  5. Create a project from scratch:
    1. Create a project directory
    2. Add source code and optionally test code however you'd like it organized
    3. Create a Ceedling project file in the root of your project directory
  6. Run Ceedling tasks from the working directory of your project

Ceedling requires a command line C toolchain be available in your path. It's flexible enough to work with most anything on any platform. By default, Ceedling is ready to work with GCC out of the box (we recommend the MinGW project on Windows).

A common build strategy with tooling other than GCC is to use your target toolchain for release builds (with or without Ceedling) but rely on Ceedling + GCC for test builds (more on all this here).

Command Line & Build Tasks

Once you have Ceedling installed, you always have access to ceedling help.

And, once you have Ceedling installed, you have options for project creation using Ceedling's application commands:

  • ceedling new <name> <destination>
  • ceedling examples to list available example projects and ceedling example <name> <destination> to create a readymade sample project whose project file you can copy and modify.

Once you have a Ceedling project file and a project directory structure for your code, Ceedling build tasks go like this:

  • ceedling test:MyCodeModule, or
  • ceedling test:all, or
  • ceedling release, or, if you fancy and have the GCov plugin enabled,
  • ceedling clobber test:all gcov:all release --log --verbosity=obnoxious

Quick Start Documentation