Pigweed Sample Project

This repository outlines the recommended way of using Pigweed in a new or existing project. Feel free to fork this repository, or read it as a reference.

For more information see the Pigweed Getting started guide.

Check back for more complex examples and features coming soon!

Getting started

Make sure you've set up Pigweed's prerequisites. Once that is done, you can clone this project and all required git submodules with the following command:

git clone --recursive https://pigweed.googlesource.com/pigweed/sample_project

If you already cloned but forgot to include --recursive, run git submodule update --init to pull all submodules.

Environment setup

Pigweed uses a local development environment for most of its tools. This means tools are not installed to your machine, and are instead stored in a directory inside your project (Note: git ignores this directory). The tools are temporarily added to the PATH of the current shell session.

To make sure the latest tooling has been fetched and set up, run the bootstrap command for your operating system:

Windows

bootstrap.bat

Linux & Mac

source bootstrap.sh

After tooling updates, you might need to run bootstrap again to ensure the latest tools.

After the initial bootstrap, you can use use the activate scripts to configure the current shell for development without doing a full update.

Windows

activate.bat

Linux & Mac

source activate.sh

Building

All of these commands must be run from inside an activated developer environment. See Environment setup

First time

The first time you build, you‘ll need to use gn gen to create the build directory. You won’t need to do this again unless you delete the out directory.

gn gen out

One-shot build

To build the project, documentation, and tests, run the following command in an activated environment:

ninja -C out

Automatically build on file save

Alternatively, if you'd like an automatic rebuild to trigger whenever you save changes to files, use pw watch:

pw watch

Typical workflow

When you pull latest repository changes, run bootstrap:

source bootstrap.sh

If you're just launching a new shell session, you can activate instead:

source activate.sh

and rebuild with:

ninja -C out

More info and Examples

Extended documentation and examples are built along code changes. You can view them at out/docs/gen/docs/html/index.html.