osmocon: if we ignore a return value, we don't need to assign it to a variable

[osmocom-bb.git] / src / README.building

diff --git a/src/README.building b/src/README.building
index bfd86b6..328c9ed 100644 (file)
--- a/src/README.building
+++ b/src/README.building
@@ -2,26 +2,29 @@
 
 === Prerequisites ===
 
-We assume you are building on a GNU/Linux host system such as Debian GNU/Linux.
-Windows builds have been reported successfully using the Cygwin environment, but
-we do not officially support this.
+We assume you are building on a GNU/Linux host system such as Debian
+GNU/Linux.  Successful builds have also been reported using MacOS X
+and the Cygwin environment for MS Windows, but we do not officially support
+this.
 
  # Get a GNU toolchain (gcc/binutils) for ARM (e.g. from http://gnuarm.com/)
  # Set your path to include the arm-elf-* executables of your toolchain
+ # call 'make' in this (the src) subdirectory
 
-=== Building the actual GSM firmware ===
+=== Details ===
 
- # cd osmocom-bb/src/target/firmware
- # make
+The master Makefile will build:
 
-=== Building the osmocon terminal program and multiplexer ===
+ * libosmocore for the host (x86 or whatever you use)
+ * libosmocore for the target (ARM)
+ * osmocon and layer23 executables for the host (linking libosmocore)
+ * the actual target firmware images (in src/target/firmware/board/*/*.bin)
 
- # cd osmocom-bb/src/host/osmocon
- # make
+== Transmitting ==
 
-=== Building the layer2 binary on the host PC ===
+For safety reasons, all code that can enable the transmitter on the phone is
+disabled in the default builds.  Plese check the src/target/firmware/Makefile
+for the "#CFLAGS += -DCONFIG_TX_ENABLE" line.
 
- # cd osmocom-bb/src/host/layer2
- # autoreconf -i
- # ./configure
- # make
+Please notice that GSM operates in licensed spectrum and in most jurisdictions
+you will need a license from a regulatory authority to transmit.