[mobile] Added missing curly braces, as proposed by Harald

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

diff --git a/src/README.development b/src/README.development
index 393b0bd..1963b5a 100644 (file)
--- a/src/README.development
+++ b/src/README.development
@@ -4,9 +4,24 @@ Feel free to help us by extending the code.  Always make sure to
 send back all your patches to the baseband-devel@lists.osmocom.org
 mailing list - Free Software is all about sharing.
 
-== src/shared/libosmocore ==
+== Coding Style ==
 
-is a library of various utility routines, including linked lists,
+Like all C language Osmocom projects, we use the Linux Kernel coding
+style, you can find it in the Documentation/CodingStyle subdirectory
+of any Linux Kernel source.
+
+== More Information ==
+
+Please consult the http://bb.osmocom.org/ web page / wiki.
+
+If you have any technical questions regarding the code, don't hesitate
+to ask the baseband-devel@lists.osmocom.org mailing list.
+
+== subdirectories containing libraries and code ==
+
+=== src/shared/libosmocore ===
+
+This is a library of various utility routines, including linked lists,
 message buffers, bit-vectors, memory allocator, signals, select loop
 handling, timers - as well as some more specifically GSM related things
 like a TLV parser, a Comp128V1 implementation and utility functions for
@@ -26,7 +41,7 @@ embedded target without OS.  So please refrain from using fancy
 functions.
 
 
-== src/target/firmware ==
+=== src/target/firmware ===
 
 The firmware is what we build for the actual target (phone).  It was
 written with some idea of modularity in mind, i.e. we have
@@ -36,7 +51,7 @@ written with some idea of modularity in mind, i.e. we have
  * RF Mixer code in rf/
  * Layer1 code in layer1/
  * NOR flash handling in flash/
- * LCD display handlin in display/
+ * LCD display handling in display/
  * minimal C-Library code in lib/
  * communications utility routines in comm/
  * Board (phone model/family) specific code in board/
@@ -45,13 +60,13 @@ written with some idea of modularity in mind, i.e. we have
  * Applications (each app builds one firmware image) in apps/
 
 
-== src/target_dsp/calypso ==
+=== src/target_dsp/calypso ===
 
 This is where we keep some (assembly) code that we wrote for
-the DSP that is part of the Caylypso DBB.
+the DSP that is part of the Calypso DBB.
 
-== host/layer23 ==
+=== src/host/layer23 ===
 
-The Layer2 (LAPDm / TS 04.06) and Layer3 (CC/MM/RR / 04.08)
+The Layer2 (LAPDm / TS 04.06) and Layer3 (CC/MM/RR / TS 04.08)
 implementations, as they are growing.