Merge pull request #94 from olerem/crypto

[open-ath9k-htc-firmware.git] / README

diff --git a/README b/README
index f65902d1f94f224e681f3f034671a39b03aa005d..93823e4c9afd99bdd4b995dc6b0dbb29be322f10 100644 (file)
--- a/README
+++ b/README
@@ -8,6 +8,26 @@ 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?
 ------------------------
@@ -25,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:
@@ -41,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?
 ----------