1 files changed, 19 insertions, 0 deletions
diff --git a/nuttx/drivers/sercomm/README.txt b/nuttx/drivers/sercomm/README.txt
new file mode 100755
index 000000000..a9239a204
--- /dev/null
+++ b/nuttx/drivers/sercomm/README.txt
@@ -0,0 +1,19 @@
+drivers/sercomm README
+======================
+
+If CONFIG_SERCOMM_CONSOLE is defined in the NuttX configuration file, NuttX
+will attempt to use sercomm (HDLC protocol) to communicate with the
+host system. Sercomm is the transport used by osmocom-bb that runs on top
+of serial.  See http://bb.osmocom.org/trac/wiki/nuttx-bb/run for detailed
+the usage of nuttx with sercomm.
+
+The drivers/sercomm build that you have the osmocom-bb project directory
+at same level as the nuttx project:
+
+  |- nuttx
+  |- apps
+  `- osmocom-bb
+
+If you attempt to build this driver without osmocom-bb, you will get
+compilation errors  because ofheader files that are needed from the
+osmocom-bb directory.