README.md

Example Project

Quickstart: Package Installation

1. Install Python:

   sudo apt install -y python3 python3-pip python3-venv

2. Make a virtual environment (optional):

   python3 -m venv .venv
   source .venv/bin/activate

3. Update pip:

   pip install --upgrade pip

4. Install exampleproject:

   pip install .

C++ Development

1. Install C++ build tools:

   pip install  --upgrade meson ninja

2. Configure the meson project (Debug mode):

   Debug:

   meson setup -Ddebug=true -Doptimization=g build/

   Release:

   meson setup -Ddebug=false -Doptimization=3 -Db_lto=true -Db_ndebug=true build/

3. Compile:

   meson compile -C build/

4. Run tests:

   meson test
   meson test --benchmark

Python Development

1. Install editable-mode dependencies:

   pip install --upgrade meson-python meson ninja

2. Install the package in editable mode with tests enabled:

   pip uninstall -y exampleproject
   pip install --no-build-isolation --editable .[test]

3. Run tests:

   pytest python/tests