Forward port to Linux v5.17-rc3

[elmcan.git] / readme.rst

diff --git a/readme.rst b/readme.rst
index 29c5ef58e599af76f6aa63f1c77fa60a07a0da2e..5aa6b52437e39179cae53945d405cc61a1b868f3 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
 -----------
@@ -114,7 +118,7 @@ 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
+       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.
@@ -344,10 +348,3 @@ 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.
-
-
-
-To Do list for future development
-----------------------------------
-
-- None currently