readme.rst: Remove module parameter documentation

[elmcan.git] / readme.rst

diff --git a/readme.rst b/readme.rst
index 9924167e59f7073867be5f9a031775ccc7a92eab..5fb0e5e6e83e245980f2714860506719143e8388 100644 (file)
--- a/readme.rst
+++ b/readme.rst
@@ -1,4 +1,4 @@
-Linux SocketCAN driver for ELM327
+ELM327 driver for Linux SocketCAN
 ==================================
 
 Authors
@@ -24,13 +24,13 @@ Introduction
 -------------
 
 This driver is an effort to turn abundant ELM327 based OBD interfaces
-into full-fledged (as far as possible) CAN interfaces.
+into full fledged (as far as possible) CAN interfaces.
 
-Since the ELM327 was never meant to be a stand-alone CAN controller,
+Since the ELM327 was never meant to be a stand alone CAN controller,
 the driver has to switch between its modes as quickly as possible in
 order to fake full-duplex operation.
 
-As such, elmcan is a best-effort driver. However, this is more than
+As such, elmcan is a best effort driver. However, this is more than
 enough to implement simple request-response protocols (such as OBD II),
 and to monitor broadcast messages on a bus (such as in a vehicle).
 
@@ -53,7 +53,11 @@ Also, elmcan depends on ``can-dev``:
 
     sudo modprobe can-dev
 
+Install
+-------------
+    cd module/
 
+    sudo dkms install .
 
 Data sheet
 -----------
@@ -108,23 +112,6 @@ sheet. This needs to be done before attaching the line discipline.
 
 
 
-Module parameters
-------------------
-
-- ``accept_flaky_uart`` - Try to live with a bad controller or UART line
-
-       Some adapters and/or their connection are unreliable. Enable this
-       option to try and work around the situation. This is a best-effort
-       workaround, so undefined behavior will likely occur sooner or later.
-       Without this option, the driver will bail on the first unrecognized
-       character it receives from the TTY.
-
-       LOAD TIME::
-
-               module/kernel parameter: accept_flaky_uart=[0|1]
-
-
-
 Known limitations of the controller
 ------------------------------------
 
@@ -338,11 +325,9 @@ termination resistors on its PCB and try removing them.
 
 
 
-To Do list for future development
-----------------------------------
+Thanks
+-------
 
-- DMA capable rx/tx buffers
-  (is this relevant for this driver?)
+Thanks go out to Oliver Neukum for his early reviews and suggestions.
 
-- flushing of ``tx_work`` is too late in ``ldisc_close()``
-  (is this still the case?)
+Several more people have encouraged me to finish this - thank you all.