--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Thu Oct 19 21:35:54 2017 +0000
@@ -0,0 +1,31 @@
+This repository contains the source for the audio mode config files that need
+to be uploaded into the flash file system (FFS) of FreeCalypso GSM devices
+under /aud, along with the necessary Makefiles that compile these sources into
+the binaries that are actually uploaded into the FFS of FreeCalypso devices.
+
+The *.cfg and *.vol files that are compiled from the sources in this repository
+are uploaded into the FFS of FreeCalypso devices on the factory production line,
+however, these configurations will inevitably receive updates after the hardware
+devices for which they are intended have been produced and shipped, hence
+empowered end users (i.e., the kind of end users for whom our devices are made)
+need to be able to install updated versions of these audio configurations on
+their own devices, as well as study the source and possibly make their own
+changes.
+
+You need to have a recent version of FreeCalypso host tools (fc-host-tools-r7
+or later) installed on your host system before you can compile the binary *.cfg
+and *.vol files from the sources in this repository.  Once you have these tools
+installed, run 'make' to compile the *.cfg and *.vol files, then run
+'make install' to have them installed in /opt/freecalypso/aud-* on your host
+system.
+
+Once you have up-to-date versions of the *.cfg and *.vol files compiled from
+the present source installed on your host system under /opt/freecalypso, you
+can then upload them into the FFS of actual FreeCalypso GSM devices with the
+fc-fsio utility.  For example, to update the /aud/*.{cfg,vol} files on an
+FCDEV3B board, execute the following command:
+
+fc-fsio upload-subtree /opt/freecalypso/aud-fcdev3b /aud
+
+Change the /opt/freecalypso/aud-* source directory accordingly for other
+FreeCalypso device types.