X-Git-Url: https://jxself.org/git/?p=open-ath9k-htc-firmware.git;a=blobdiff_plain;f=README;h=93823e4c9afd99bdd4b995dc6b0dbb29be322f10;hp=00badf65e0ce896d1573bf8a2009730ebc3e8d87;hb=29426f31458682304dee9f2da0f1e9e60237018f;hpb=3a825ae8ea70d038f82e8efdf8cb9fd95f5d5761

diff --git a/README b/README
index 00badf6..93823e4 100644
--- a/README
+++ b/README
@@ -1,7 +1,6 @@
 This is the firmware for the Qualcomm Atheros AR7010 and AR9271 USB
 802.11n NICs.
 
-
 What is this exactly?
 ---------------------
 
@@ -9,13 +8,33 @@ 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 ClearBSD 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?
 ------------------------
 
 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 AR9285.
+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.
@@ -26,6 +45,11 @@ How do I build it?
 
 You're in for a treat.
 
+* Install the cmake build tool (http://www.cmake.org/).
+  Major distributions have packages for this.
+
+* For FreeBSD - install gmake and wget.
+
 * You first have to build the toolchain.
 
   * Linux:
@@ -42,17 +66,25 @@ You're in for a treat.
 
   * Linux:
 
-  $ ./build
+  $ make -C target_firmware
 
   * FreeBSD:
 
-  edit the build script, change make to gmake, and then
-
-  $ ./build
+  $ gmake -C target_firmware
 
 You will end up with two .fw files - one for the AR7010 and one for
-the AR9271.
+the AR9271 in the target_firmware directory.
 
+You can clean the firmware build (when you wish to force a rebuild)
+by doing:
+
+  * Linux:
+
+  $ make -C target_firmware clean
+
+  * FreeBSD:
+
+  $ gmake -C target_firmware clean
 
 Then what?
 ----------
@@ -62,10 +94,20 @@ system.  Yes, this means you need a driver.  No, there's no FreeBSD
 driver yet for this particular chipset, sorry.
 
 
-Further information
--------------------
+Where do I file bugs?
+---------------------
+
+Please file bugs in github - http://github.com/qca/open-ath9k-htc-firmware/issues .
+
+
+Mailing lists?
+--------------
+
+Here you go:
 
-Bug tracking and email list will appear here shortly.
+http://lists.infradead.org/mailman/listinfo/ath9k_htc_fw
 
+And
 
+ath9k_htc_fw@lists.infradead.org