summaryrefslogtreecommitdiffstats
path: root/src/README.development
diff options
context:
space:
mode:
authorHarald Welte2010-12-11 04:38:59 +0100
committerHarald Welte2010-12-11 04:38:59 +0100
commit155cbeab1dcf82f6779c10320ce0eafad3f15780 (patch)
tree11f78c913315e675cbdbf9a10e79887c35e04464 /src/README.development
parentlayer23: use correct sizeof(sockaddr) for connecting to L1CTL socket (diff)
downloadosmocom-155cbeab1dcf82f6779c10320ce0eafad3f15780.tar.gz
osmocom-155cbeab1dcf82f6779c10320ce0eafad3f15780.tar.xz
osmocom-155cbeab1dcf82f6779c10320ce0eafad3f15780.zip
README update about transmit as well as development
Diffstat (limited to 'src/README.development')
-rw-r--r--src/README.development25
1 files changed, 20 insertions, 5 deletions
diff --git a/src/README.development b/src/README.development
index 393b0bd..2e55f31 100644
--- a/src/README.development
+++ b/src/README.development
@@ -4,7 +4,22 @@ 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 ==
+
+Lie 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 ===
is a library of various utility routines, including linked lists,
message buffers, bit-vectors, memory allocator, signals, select loop
@@ -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
@@ -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.
-== 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.