diff options
author | norly <ny-git@enpas.org> | 2022-02-11 00:18:08 +0100 |
---|---|---|
committer | norly <ny-git@enpas.org> | 2022-02-11 00:37:17 +0100 |
commit | 2210ae58494760f1e8c9a59123dd7ca0dbb4b348 (patch) | |
tree | 35814f81468cbab74d8a596faa95a52fa643a629 | |
parent | 381e51e0ffe73f454da6aeb58b7f2b7aa514a90e (diff) |
readme.rst: Split off out-of-tree documentation
This simplifies syncing changes with a future upstreamed version.
-rw-r--r-- | out-of-tree.rst | 29 | ||||
-rw-r--r-- | readme.rst | 34 |
2 files changed, 39 insertions, 24 deletions
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. @@ -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. |