Operator

Initial Setup

1. Clone the repo with --recursiveto get the driver submodule:

git clone --recursive <repo-url>

Note: Replace <repo-url> with the actual URL of the repository.

Compilation and Development

A Linux machine is required to develop and compile the operator. If you are on macOS or Windows, skip to Additional Steps for macOS/Windows.

Compilation

The command to compile the operator is:

make erv

To compile the operator with the driver for the ER 4pc, also known as ichor, use:

make ichor

Additional steps for macOS/Windows

If you are on macOS or Windows, it is impossible to compile the operator/driver directly. This makes development challenging since you are unable to use all the features of your IDE during development. You can use a Linux virtual machine (VM) or Docker to compile the operator. Below are the steps to set up a Dev Container for development. It is recommended to use the Dev Containers extension for VS Code for a smoother experience.

1. Install Docker and VS Code.
2. Install the Dev Containers extension in VS Code. Note: The installed Docker version needs to be compatible with the Dev Containers extension. Check the documentation for more information.
3. Open the cloned repository in VS Code.
4. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS) and select Dev Containers: Open Folder in Container.