[PATCH 2/3] ath9k_htc_firmware: rename README to README.md

[Adrian Chadd]

Hiya,

Would you mind resubmitting this against the current contents of README?

Thanks,



adrian


On 12 March 2013 13:04, Luis R. Rodriguez <mcgrof at do-not-panic.com> wrote:
> 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.
>
> Signed-off-by: Luis R. Rodriguez <mcgrof at do-not-panic.com>
> ---
>  README    |  104 -------------------------------------------------------------
>  README.md |   97 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 97 insertions(+), 104 deletions(-)
>  delete mode 100644 README
>  create mode 100644 README.md
>
> diff --git a/README b/README
> deleted file mode 100644
> index 1f0730c..0000000
> --- a/README
> +++ /dev/null
> @@ -1,104 +0,0 @@
> -This is the firmware for the Qualcomm Atheros AR7010 and AR9271 USB
> -802.11n NICs.
> -
> -What is this exactly?
> ----------------------
> -
> -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?
> ---------------------------------
> -
> -The Qualcomm Atheros owned code is under the ISC licence.
> -
> -The NOTICES.TXT file contains copyright notices for software which
> -this firmware release leverages.
> -
> -There is some code that is based off of work done under contract
> -but is owned by Qualcomm Atheros; the original copyright statements
> -from that work are in NOTICES.TXT.
> -
> -The Tensilica code (xtos/xtensa) is distributed with permission from
> -Tensilica, Inc., under the MIT licence.
> -
> -There are three ECOS source files distributed under the terms of
> -the GPLv2, with a caveat that linking or using the source files does
> -not bring the rest of the binary under the GPLv2.  Please read the
> -ECOS caveats in more detail.
> -
> -
> -Ok, what are those NICs?
> -------------------------
> -
> -For a list of devices available on the market right now see:
> -
> -http://wireless.kernel.org/en/users/Drivers/ath9k_htc/devices
> -
> -The AR7010 is a USB/PCIe SoC with onboard RAM, ROM and flash.
> -It comes with an external wireless chip connected via PCIe - typically
> -an AR9280 or AR9287.
> -
> -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.)
> -
> -* Next, build the firmware.
> -
> -  * Linux:
> -
> -  $ ./build
> -
> -  * FreeBSD:
> -
> -  edit the build script, change make to gmake, and then
> -
> -  $ ./build
> -
> -You will end up with two .fw files - one for the AR7010 and one for
> -the AR9271.
> -
> -
> -Then what?
> -----------
> -
> -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.
> -
> -
> -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
> -
> -ath9k_htc_fw at lists.infradead.org
> -
> diff --git a/README.md b/README.md
> new file mode 100644
> index 0000000..09a44c3
> --- /dev/null
> +++ b/README.md
> @@ -0,0 +1,97 @@
> +This is the firmware for the Qualcomm Atheros AR7010 and AR9271 USB
> +802.11n NICs.
> +
> +# What is this exactly?
> +
> +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?
> +
> +The Qualcomm Atheros owned code is under the ISC licence.
> +
> +The NOTICES.TXT file contains copyright notices for software which
> +this firmware release leverages.
> +
> +There is some code that is based off of work done under contract
> +but is owned by Qualcomm Atheros; the original copyright statements
> +from that work are in NOTICES.TXT.
> +
> +The Tensilica code (xtos/xtensa) is distributed with permission from
> +Tensilica, Inc., under the MIT licence.
> +
> +There are three ECOS source files distributed under the terms of
> +the GPLv2, with a caveat that linking or using the source files does
> +not bring the rest of the binary under the GPLv2.  Please read the
> +ECOS caveats in more detail.
> +
> +
> +# Ok, what are those NICs?
> +
> +For a list of devices available on the market right now see:
> +
> +http://wireless.kernel.org/en/users/Drivers/ath9k_htc/devices
> +
> +The AR7010 is a USB/PCIe SoC with onboard RAM, ROM and flash.
> +It comes with an external wireless chip connected via PCIe - typically
> +an AR9280 or AR9287.
> +
> +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.)
> +
> +* Next, build the firmware.
> +
> +  * Linux:
> +
> +  $ ./build
> +
> +  * FreeBSD:
> +
> +  edit the build script, change make to gmake, and then
> +
> +  $ ./build
> +
> +You will end up with two .fw files - one for the AR7010 and one for
> +the AR9271.
> +
> +
> +# Then what?
> +
> +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.
> +
> +
> +# 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
> +
> +ath9k_htc_fw at lists.infradead.org
> +
> --
> 1.7.10.4
>