From 2210ae58494760f1e8c9a59123dd7ca0dbb4b348 Mon Sep 17 00:00:00 2001 From: norly Date: Fri, 11 Feb 2022 00:18:08 +0100 Subject: [PATCH] readme.rst: Split off out-of-tree documentation This simplifies syncing changes with a future upstreamed version. --- out-of-tree.rst | 29 +++++++++++++++++++++++++++++ readme.rst | 34 ++++++++++------------------------ 2 files changed, 39 insertions(+), 24 deletions(-) create mode 100644 out-of-tree.rst diff --git a/out-of-tree.rst b/out-of-tree.rst new file mode 100644 index 0000000..875ecf7 --- /dev/null +++ b/out-of-tree.rst @@ -0,0 +1,29 @@ +Using ELM327 driver out-of-tree +================================ + +Requirements +------------- + +This requires Linux 4.11 (for 431af779256c), and has been tested on 4.19. + +Also, elmcan depends on ``can-dev``: + + sudo modprobe can-dev + + + +Install +------- + cd module/ + + sudo dkms install . + + + + +Thanks +======= + +Thanks go out to Oliver Neukum for his early reviews and suggestions. + +Several more people have encouraged me to finish this - thank you all. diff --git a/readme.rst b/readme.rst index 5fb0e5e..408c691 100644 --- a/readme.rst +++ b/readme.rst @@ -1,6 +1,16 @@ +.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) + ELM327 driver for Linux SocketCAN ================================== +Out-of-tree version +-------------------- + +This is the non-upstreamed version of the elmcan driver. +Please see out-of-tree.rst for compilation/usage hints. + + + Authors -------- @@ -44,21 +54,6 @@ known limitations in older controllers and clones. -Requirements -------------- - -This requires Linux 4.11 (for 431af779256c), and has been tested on 4.19. - -Also, elmcan depends on ``can-dev``: - - sudo modprobe can-dev - -Install -------------- - cd module/ - - sudo dkms install . - Data sheet ----------- @@ -322,12 +317,3 @@ not helpful when trying to tap into the middle of an existing CAN bus. If communications don't work with the adapter connected, check for the termination resistors on its PCB and try removing them. - - - -Thanks -------- - -Thanks go out to Oliver Neukum for his early reviews and suggestions. - -Several more people have encouraged me to finish this - thank you all. -- 2.30.2