src/README.building

   1 == How to build OsmocomBB? ==
   2
   3 === Prerequisites ===
   4
   5 We assume you are building on a GNU/Linux host system such as Debian
   6 GNU/Linux.  Successful builds have also been reported using MacOS X
   7 and the Cygwin environment for MS Windows, but we do not officially support
   8 this.
   9
  10  * Make sure you have compiled and installed a recent version of
  11    libosmocore. See http://bb.osmocom.org/trac/wiki/libosmocore
  12
  13    DO NOT USE the libosmocore version embedded in this git tree. This
  14    is a special version used internally and MUST NOT be used as
  15    system-wide libosmocore.
  16
  17  * Get a GNU toolchain (gcc/binutils) for ARM (e.g. from http://gnuarm.com/)
  18  * Set your path to include the arm-elf-* executables of your toolchain
  19
  20  * call 'make' in this (the src) subdirectory
  21
  22 === Details ===
  23
  24 The master Makefile will build:
  25
  26  * libosmocore for the target (ARM)
  27  * osmocon and layer23 executables for the host (linking libosmocore)
  28  * the actual target firmware images (in src/target/firmware/board/*/*.bin)
  29
  30
  31 == Transmitting ==
  32
  33 For safety reasons, all code that can enable the transmitter on the phone is
  34 disabled in the default builds.  Plese check the src/target/firmware/Makefile
  35 for the "#CFLAGS += -DCONFIG_TX_ENABLE" line.
  36
  37 Please notice that GSM operates in licensed spectrum and in most jurisdictions
  38 you will need a license from a regulatory authority to transmit.