aboutsummaryrefslogtreecommitdiffstats
path: root/docs/CANBUS.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-05-28 20:58:32 -0400
committerKevin O'Connor <kevin@koconnor.net>2021-05-28 20:58:32 -0400
commit977c334e2ec15647dda128516f286cdcfeab2964 (patch)
treeab6bcc548b577cadd2431c57bf9f3403fb292a9c /docs/CANBUS.md
parent624d94f6acbcb6f860d6f1c01c81e277bbf1f21e (diff)
downloadkutter-977c334e2ec15647dda128516f286cdcfeab2964.tar.gz
kutter-977c334e2ec15647dda128516f286cdcfeab2964.tar.xz
kutter-977c334e2ec15647dda128516f286cdcfeab2964.zip
docs: Avoid link descriptions that span multiple lines
The Jekyll markdown renderer gets confused by links that span multiple lines. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/CANBUS.md')
-rw-r--r--docs/CANBUS.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/CANBUS.md b/docs/CANBUS.md
index 2446c533..de652cee 100644
--- a/docs/CANBUS.md
+++ b/docs/CANBUS.md
@@ -15,17 +15,17 @@ and flash it to the target board.
In order to use a CAN bus, it is necessary to have a host adapter.
There are currently two common options:
-1. Use a [Waveshare Raspberry Pi CAN
- hat](https://www.waveshare.com/rs485-can-hat.htm) or one of its
- many clones.
+1. Use a
+ [Waveshare Raspberry Pi CAN hat](https://www.waveshare.com/rs485-can-hat.htm)
+ or one of its many clones.
2. Use a USB CAN adapter (for example
[https://hacker-gadgets.com/product/cantact-usb-can-adapter/](https://hacker-gadgets.com/product/cantact-usb-can-adapter/)). There
are many different USB to CAN adapters available - when choosing
- one, we recommend verifying it can run the [candlelight
- firmware](https://github.com/candle-usb/candleLight_fw). (Unfortunately,
- we've found some USB adapters run defective firmware and are locked
- down, so verify before purchasing.)
+ one, we recommend verifying it can run the
+ [candlelight firmware](https://github.com/candle-usb/candleLight_fw).
+ (Unfortunately, we've found some USB adapters run defective
+ firmware and are locked down, so verify before purchasing.)
It is also necessary to configure the host operating system to use the
adapter. This is typically done by creating a new file named
@@ -37,8 +37,8 @@ iface can0 can static
up ifconfig $IFACE txqueuelen 128
```
-Note that the "Raspberry Pi CAN hat" also requires [changes to
-config.txt](https://www.waveshare.com/wiki/RS485_CAN_HAT).
+Note that the "Raspberry Pi CAN hat" also requires
+[changes to config.txt](https://www.waveshare.com/wiki/RS485_CAN_HAT).
# Terminating Resistors