From b3edbc209bbaaf16e95d5477818be2f515ccaf41 Mon Sep 17 00:00:00 2001
From: drowe67 <drowe67@01035d8c-6547-0410-b346-abe4f91aad63>
Date: Tue, 3 Jun 2014 21:15:27 +0000
Subject: [PATCH] updating README's for cmake

git-svn-id: https://svn.code.sf.net/p/freetel/code@1631 01035d8c-6547-0410-b346-abe4f91aad63
---
 codec2/README           | 25 ++++++++++---------------
 codec2/README_fdmdv.txt |  2 +-
 2 files changed, 11 insertions(+), 16 deletions(-)

diff --git a/codec2/README b/codec2/README
index c070222d..ab79a4d0 100644
--- a/codec2/README
+++ b/codec2/README
@@ -1,8 +1,8 @@
 Codec 2 README
 --------------
 
-Codec 2 is an open source (LGPL licensed) speech codec for 2400 bit/s
-and below.  For more information please see:
+Codec 2 is an open source (LGPL licensed) speech codec for 1200-3200
+bit/s.  For more information please see:
 
     http://rowetel.com/codec2.html
 
@@ -12,10 +12,10 @@ Quickstart
 ----------
 
 1/ Listen to Codec 2:
- *** FIRST STEP OBSOLETE: See README.cmake for building ***
-   $ ./configure && make
-   $ cd src
-   $ ./c2demo ../raw/hts1a.raw hts1a_c2.raw
+   $ cd codec2
+   $ mkdir build_linux
+   $ cmake && make
+   $ ./src/c2demo ../raw/hts1a.raw hts1a_c2.raw
    $ ../script/menu.sh ../raw/hts1a.raw hts1a_c2.raw
 
    NOTE: For playback testing, menu.sh requires either the 'play',
@@ -25,12 +25,12 @@ Quickstart
 
 2/ Compress and Decompress a file:
 
-   $ ./c2enc 2400 ../raw/hts1a.raw hts1a_c2.bit
-   $ ./c2dec 2400 hts1a_c2.bit hts1a_c2.raw 
+   $ ./src/c2enc 2400 ../raw/hts1a.raw hts1a_c2.bit
+   $ ./src/c2dec 2400 hts1a_c2.bit hts1a_c2.raw 
 
 3/ Same thing with pipes:
 
-   $ ./c2enc 1400 ../raw/hts1a.raw - | ./c2dec 1400 - - | play -t raw -r 8000 -s -2 -
+   $ ./src/c2enc 1400 ../raw/hts1a.raw - | ./src/c2dec 1400 - - | play -t raw -r 8000 -s -2 -
 
 Programs
 --------
@@ -70,15 +70,10 @@ Directories
   portaudio - Portaudio test programs
   script    - shell scripts for playing and converting raw files
   src       - C source code
+  stm32     - STM2F4 uC support
   raw       - speech files in raw format (16 bits signed linear 8 kHz)
   unittest  - unit test source code
   voicing   - hand-estimated voicing files, used for development
   wav       - speech files in wave file format
   win32     - Support for building Windows DLL version of Codec 2 and FDMDV libraries
 
-TODO
-----
-
-[ ] Get win32/Makefile integrated into Automake system, such that if
-    i586-mingw32msvc exists the Win32 code gets automatically built.
-[ ] Same for fltk & portaudio, build these conditionally if libs exist
diff --git a/codec2/README_fdmdv.txt b/codec2/README_fdmdv.txt
index fd920ba9..64c6a854 100644
--- a/codec2/README_fdmdv.txt
+++ b/codec2/README_fdmdv.txt
@@ -18,7 +18,7 @@ Quickstart
 ----------
 
 $ cd codec2
-$ ./configure && make
+$ cmake && make
 $ cd src
 
 1. Generate some test bits and modulate them:
-- 
2.25.1