This simplifies syncing changes with a future upstreamed version.
--- /dev/null
+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.
+.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
+
ELM327 driver for Linux SocketCAN
==================================
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.
+
+
+
-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 .
-
If communications don't work with the adapter connected, check for the
termination resistors on its PCB and try removing them.
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.