Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README: use relative links #5

Merged
merged 1 commit into from
Aug 25, 2024
Merged

README: use relative links #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ other software packages.
The firmware, which is based on the [Zephyr RTOS](https://www.zephyrproject.org), allows turning
your favorite microcontroller development board into a full-fledged USB to CAN adapter.

CANnectivity is licenced under the [Apache-2.0
license](https://github.com/CANnectivity/cannectivity/blob/main/LICENSE).
CANnectivity is licenced under the [Apache-2.0 license](LICENSE).

## Firmware Features

Expand All @@ -37,8 +36,7 @@ The CANnectivity firmware supports the following features, some of which depend
- Support for hardware timestamping of received and transmitted CAN frames
- CAN bus state reporting
- CAN bus error reporting
- Automatic gs_usb driver loading under Linux using custom [udev
rules](https://github.com/CANnectivity/cannectivity/blob/main/99-cannectivity.rules)
- Automatic gs_usb driver loading under Linux using custom [udev rules](99-cannectivity.rules)
- Automatic WinUSB driver installation under Microsoft Windows 8.1 and newer

## Hardware Requirements
Expand All @@ -61,8 +59,9 @@ is used as status LED. This means that virtually any Zephyr board configuration
device, a CAN controller, and an optional user LED will work without any further configuration.

Advanced board configuration (e.g. multiple CAN controllers, multiple LEDs, hardware timestamp
counter) is also supported via devicetree overlays. Check the description for the `cannectivity`
devicetree binding under `app/dts/bindings/` and example devicetree overlays under `app/boards/`.
counter) is also supported via devicetree overlays. Check the description for the
[cannectivity](app/dts/bindings/cannectivity.yaml) devicetree binding and [example devicetree
overlays](app/boards).

## Building and Running

Expand Down