Skip to content

Commit

Permalink
README: add instructions for pulling in CANnectivity as a Zephyr module
Browse files Browse the repository at this point in the history
Add instructions for pulling in CANnectivity as a Zephyr module.

Signed-off-by: Henrik Brix Andersen <[email protected]>
  • Loading branch information
henrikbrixandersen committed Aug 25, 2024
1 parent c3add6b commit 8e67188
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,23 @@ provided. These can be selected by setting either `FILE_SUFFIX=usbd_next` or
`FILE_SUFFIX=usbd_next_release`.

After building, the firmware can be flashed to the board by running the `west flash` command.

## CANnectivity as a Zephyr Module

The CANnectivity firmware repository is a [Zephyr
module](https://docs.zephyrproject.org/latest/develop/modules.html) which allows for reuse of its
components (i.e. the "gs_usb" protocol implementation) outside of the CANnectivity firmware
application.

To pull in CANnectivity as a Zephyr module, either add it as a West project in the `west.yaml` file
or pull it in by adding a submanifest (e.g. `zephyr/submanifests/cannectivity.yaml`) file with the
following content and run `west update`:

```yaml
manifest:
projects:
- name: cannectivity
url: https://github.com/CANnectivity/cannectivity.git
revision: main
path: custom/cannectivity # adjust the path as needed
```

0 comments on commit 8e67188

Please sign in to comment.