[PATCH] ath9k_htc_firmware: rename README to README.md

[Luis R. Rodriguez]

From: "Luis R. Rodriguez" <mcgrof at do-not-panic.com>

Use the github markup language. This allows README's
to have dynamic links and display on github.

I've done a bit of trimmng too.

Signed-off-by: Luis R. Rodriguez <mcgrof at do-not-panic.com>
---
 README => README.md |   83 +++++++++++++++++----------------------------------
 1 file changed, 28 insertions(+), 55 deletions(-)
 rename README => README.md (57%)

diff --git a/README b/README.md
similarity index 57%
rename from README
rename to README.md
index 18af41f..788c3a3 100644
--- a/README
+++ b/README.md
@@ -1,15 +1,12 @@
-This is the firmware for the Qualcomm Atheros AR7010 and AR9271 USB
-802.11n NICs.
-
-What is this exactly?
----------------------
+ath9k_htc open firmare
+======================
 
-This is the firmware which resides in RAM on the AR7010/AR9271 NICs.
-It is used by ath9k (Linux) and athn (OpenBSD) to provide wireless
-services.
+This is the firmware for the Qualcomm Atheros AR7010 and AR9271 USB
+802.11n NICs. This is the firmware which resides in RAM on the
+AR7010/AR9271 NICs. It is used by ath9k (Linux) and athn (OpenBSD)
+to provide wireless services.
 
-What licence is this covered by?
---------------------------------
+## What licence is this covered by?
 
 The Qualcomm Atheros owned code is under the ClearBSD licence.
 
@@ -29,8 +26,7 @@ not bring the rest of the binary under the GPLv2.  Please read the
 ECOS caveats in more detail.
 
 
-Ok, what are those NICs?
-------------------------
+## Ok, what are those NICs?
 
 The AR7010 is a USB/PCIe SoC with onboard RAM, ROM and flash.
 It comes with an external wireless chip connected via PCIe - typically
@@ -40,61 +36,38 @@ The AR9271 is a USB/Wifi SoC with onboad RAM, ROM, flash and the
 actual wireless chip.  The wireless core is an off-shoot of the AR9285.
 It is a single-chip solution.
 
-How do I build it?
-------------------
-
-You're in for a treat.
-
-* You first have to build the toolchain.
-
-  * Linux:
-
-  $ make toolchain
-
-  * FreeBSD:
-
-  $ gmake toolchain
-
-  (Yes, I made this work on FreeBSD as well.)
+## How do I build it?
 
-* Next, build the firmware.
-
-  * Linux:
+You will end up with two .fw files - one for the AR7010 and one for
+the AR9271. You can build this on Linux and FreeBSD. You first
+have to buid the toolchain and then the firmware.
 
-  $ ./build
+### Linux
 
-  * FreeBSD:
+```bash 
+make toolchain
+./build
+```
 
-  edit the build script, change make to gmake, and then
+### FreeBSD
 
-  $ ./build
+Edit the build script, change make to gmake, and then
 
-You will end up with two .fw files - one for the AR7010 and one for
-the AR9271.
+```bash 
+gmake toolchain
+./build
+```
 
-
-Then what?
-----------
+## Install the firmware
 
 You need to then copy this into the relevant location for your operating
 system.  Yes, this means you need a driver.  No, there's no FreeBSD
 driver yet for this particular chipset, sorry.
 
+## Bug reports
 
-Where do I file bugs?
----------------------
-
-Please file bugs in github - http://github.com/qca/open-ath9k-htc-firmware/issues .
-
-
-Mailing lists?
---------------
-
-Here you go:
-
-http://lists.infradead.org/mailman/listinfo/ath9k_htc_fw
-
-And
+Please file [bugs in github](http://github.com/qca/open-ath9k-htc-firmware/issues) 
 
-ath9k_htc_fw at lists.infradead.org
+## Mailing lists
 
+  * [Mailing List for ath9k_htc](http://lists.infradead.org/mailman/listinfo/ath9k_htc_fw) 
-- 
1.7.10.4