fsodeviced: accelerometer_lis302: enable full_scale config variable
[cornucopia.git] / README
diff --git a/README b/README
index 5dbfad8..7430950 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,34 @@
 This is the Vala/C reference implementation of the freesmartphone.org APIs,
 codename 'Cornucopia'.
 
-Please see http://www.freesmartphone.org/index.php/Cornucopia
+Please see http://wiki.freesmartphone.org/index.php/Cornucopia
+
+=== The Cornucopia Libraries ===
+
+The Cornucopia libraries contain utility functions for freesmartphone.org API implementors.
+
+Paradigm: Test Driven Development
+
+Indentation: -bad -bap -bbb -bl -bli0 -bs -cbi4 -cli4 -i4 -l100 -lp
+             -nbbo -nbc -ncs -npcs -npsl -nut
+             -pi0 -prs-saf -sai -saw -sbi4 -st
+
+Note: Some of this code may need several Vala patches that have not been integrated into
+an upstream Vala release yet. For this, we provide intermediate git snapshot tarballs at
+available from http://www.freesmartphone.org/sources.
+
+Build Order:
+
+0. specs (external repository)
+1. libfsobasics
+2. libfsotransport
+3. libfsoframework
+4. libgsm0710 (external repository)
+5. libgsm0710mux
+6. libfso-glib (external repository)
+7. libfsoresource
+
+NOTE: Although there is a top-level Makefile present, you rather want to build the individual
+projects. The top-level Makefile is just a convenience for me :) [Patches to make a full
+recursive autotools project out of it appreciated...]
+