readme.rst: Split off out-of-tree documentation
[elmcan.git] / out-of-tree.rst
diff --git a/out-of-tree.rst b/out-of-tree.rst
new file mode 100644 (file)
index 0000000..875ecf7
--- /dev/null
@@ -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.