Fix #include order

[oweals/nmrpflash.git] / README.md

diff --git a/README.md b/README.md
index 9264b6027e54387d4b3a324a634b74dab3223c7a..5cf20c177758d1bb2ac6f7eefa7bb64685a48e82 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,16 +6,40 @@ This program uses Netgear's [NMRP protocol]
 to flash a new firmware image to a compatible device. This utility has been
 tested with a Netgear EX2700, but is likely to work on many others as well.
 
+Prebuilt binaries for Linux, OS X and Windows are available
+[here](https://github.com/jclehner/nmrpflash/releases).
+
+To run `nmrpflash` on Windows, install
+[WinPcap](https://www.winpcap.org/install/default.htm).
+
+````
+Usage: nmrpflash [OPTIONS...]
+
+Options (-a, -i and -f are mandatory):
+ -a <ipaddr>     IP address to assign to target device
+ -f <firmware>   Firmware file
+ -i <interface>  Network interface directly connected to device
+ -m <mac>        MAC address of target device (xx:xx:xx:xx:xx:xx)
+ -M <netmask>    Subnet mask to assign to target device
+ -t <timeout>    Timeout (in milliseconds) for regular messages
+ -T <timeout>    Time to wait after successfull TFTP upload
+ -p <port>       Port to use for TFTP upload
+ -U              Test TFTP upload
+ -v              Be verbose
+ -V              Print version and exit
+ -L              List network interfaces
+ -h              Show this screen
+````
+
 ### Using nmrpflash
 
 Connect your Netgear router to your computer using a network cable.
-Assign a static IP address to your computer (more specifically, to 
-the network card that's plugged into the Netgear router).
-
+Assign a static IP address to the network adapter that's plugged into
+the Netgear router.
 
 For this example, we'll assume that your network interface is `eth0`.
 First, we have to assign a static IP address to our network interface.
-In this example, we'll use `192.168.1.2`. All available network interfaces 
+In this example, we'll use `192.168.1.2`. All available network interfaces
 can be listed using
 
 ````
@@ -38,6 +62,27 @@ Waiting for remote to respond.
 Remote finished. Closing connection.
 ````
 
+### Common issues
+###### "No suitable network interfaces found."
+
+If you're *not* on Windows, rerun `nmrpflash -L` using `sudo`. In any case,
+use `-vvvL` to see more detailed messages, and file a bug report if applicable.
+
+###### "No response after 60 seconds. Bailing out."
+
+The router did not respond. Try running `nmrpflash` with `-m` and specify
+your router's MAC address. It's also entirely possible that your device does
+not support the NMRP protocol.
+
+###### "Timeout while waiting for 0x04."
+
+After a successful file upload, `nmrpflash` waits for up to 120 seconds for an
+answer from your device. You can increase this by specifying a longer timeout
+using `-T` switch (argument is in seconds).
+
+It's entirely possible that the image was flashed successfully, but the
+operation took longer than 120 seconds.
+
 ### Building and installing
 ###### Linux, Mac OS X, BSDs
 
@@ -47,9 +92,9 @@ $ make && sudo make install
 
 ###### Windows
 
-The repository includes a 
+The repository includes a
 [DevCpp](http://sourceforge.net/projects/orwelldevcpp/)
-project file (`nmrpflash.dev`). Download the latest 
-[WinPcap Developer Pack](http://www.winpcap.org/devel.htm) 
+project file (`nmrpflash.dev`). Download the latest
+[WinPcap Developer Pack](https://www.winpcap.org/devel.htm)
 and extract it into the root folder of the nmrpflash sources.