summaryrefslogtreecommitdiffstats
path: root/Src/osmocombb/src/README.building
diff options
context:
space:
mode:
Diffstat (limited to 'Src/osmocombb/src/README.building')
-rw-r--r--Src/osmocombb/src/README.building30
1 files changed, 30 insertions, 0 deletions
diff --git a/Src/osmocombb/src/README.building b/Src/osmocombb/src/README.building
new file mode 100644
index 0000000..328c9ed
--- /dev/null
+++ b/Src/osmocombb/src/README.building
@@ -0,0 +1,30 @@
+== How to build OsmocomBB? ==
+
+=== Prerequisites ===
+
+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
+
+=== Details ===
+
+The master Makefile will build:
+
+ * 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)
+
+== Transmitting ==
+
+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.
+
+Please notice that GSM operates in licensed spectrum and in most jurisdictions
+you will need a license from a regulatory authority to transmit.