From 866077a1f7cebd90817cbc0537bff87d5b5ac193 Mon Sep 17 00:00:00 2001
From: hobbes1069 <hobbes1069@01035d8c-6547-0410-b346-abe4f91aad63>
Date: Fri, 7 Aug 2015 17:22:59 +0000
Subject: [PATCH] Add comments to the cmake config and cleanup/tweak
 documentation.

git-svn-id: https://svn.code.sf.net/p/freetel/code@2260 01035d8c-6547-0410-b346-abe4f91aad63
---
 codec2-dev/CMakeLists.txt |  1 +
 codec2-dev/INSTALL        | 47 +++++++++++++++++++++++++++++++++++++++
 codec2-dev/README         |  5 ++---
 codec2-dev/README.cmake   | 41 ----------------------------------
 4 files changed, 50 insertions(+), 44 deletions(-)
 delete mode 100644 codec2-dev/README.cmake

diff --git a/codec2-dev/CMakeLists.txt b/codec2-dev/CMakeLists.txt
index ef2ecf31..dcc0f730 100644
--- a/codec2-dev/CMakeLists.txt
+++ b/codec2-dev/CMakeLists.txt
@@ -99,6 +99,7 @@ endif(MINGW)
 #
 option(BUILD_SHARED_LIBS
     "Build shared library. Set to OFF for static library." ON)
+# Unittest should be on for dev builds and off for releases.
 option(UNITTEST "Build unittest binaries." ON)
 option(INSTALL_EXAMPLES "Install example code." OFF)
 if(INSTALL_EXAMPLES)
diff --git a/codec2-dev/INSTALL b/codec2-dev/INSTALL
index e69de29b..4500c4c2 100644
--- a/codec2-dev/INSTALL
+++ b/codec2-dev/INSTALL
@@ -0,0 +1,47 @@
+==========================
+ Building and Installing
+==========================
+
+NOTES:
+  - Builds against system libraries by default.
+  - Has NSIS packaing support for Windows (WIN32) targets. *nix systems should
+    rely on 'make install' as the packages (RPM & DEB) created by CPack are
+    questionable.
+
+To test the cmake build make a directory anywhere underneath (or outside of)
+the source directory.
+
+Linux command line example:
+
+$ cd /path/to/codec2
+$ mkdir build_linux
+$ cd build_linux
+$ cmake ../ 
+
+Install prefix defaults to /usr/local, use CMAKE_INSTALL_PREFIX to override.
+
+(if no errors)
+$ make
+(as root)
+$ make install
+
+=====================
+ Windows
+=====================
+
+Unlike FreeDV (fdmdv2), codec2 is not currently provided as a separate
+installer, instead the windows version uses a static build of codec2.
+
+Additionally, while MSYS2+MinGW should work, windows builds are produces by 
+cross compiling from linux.
+
+Install MinGW & the mysys shell
+   + pwd -W prints true Win32 directory
+   + I also installed emacs, "tortise svn", and "cmake", and built and installed speex
+
+$ cd codec2-dev
+$ mkdir build_win32
+$ cd build_win32
+$ cmake -DSPEEXDSP_INCLUDE_DIR=/usr/local/include/ -G "MSYS Makefiles" ..
+$ make
+$ make package
diff --git a/codec2-dev/README b/codec2-dev/README
index 4cd93a59..a2a822d7 100644
--- a/codec2-dev/README
+++ b/codec2-dev/README
@@ -32,8 +32,7 @@ I understand the arguments, but am content with SVN for now.
 Quickstart
 ----------
 
-NOTE: Use the "codec2" or "codec2-dev" depending on which repository
-      you are working with
+Refer to INSTALL for more general building and installing instructions.
 
 NOTE: You may not have the necessary speex libraries installed. Some
       distributions may have packages available 
@@ -42,7 +41,7 @@ NOTE: You may not have the necessary speex libraries installed. Some
 
 1/ Listen to Codec 2:
 
-   $ cd codec2
+   $ cd codec2-dev
    $ mkdir build_linux
    $ cd build_linux
    $ cmake ..
diff --git a/codec2-dev/README.cmake b/codec2-dev/README.cmake
deleted file mode 100644
index 7df38268..00000000
--- a/codec2-dev/README.cmake
+++ /dev/null
@@ -1,41 +0,0 @@
-The CMake configuration for codec2 should be considered experimental at
-this time but has been thouroughly tested on Fedora Linux and cross-compiling 
-from linux to windows with mingw and has many advanages over the autotools
-config. 
-
-- Builds against system libraries (default).
-- Has experimental NSIS packaing support for Windows (WIN32) targets. *nix
-  systems should rely on 'make install' as the packages (RPM & DEB) created by
-  CPack are questionable.
-
-==========================
- Building and installing
-==========================
-
-    To test the cmake build make a directory anywhere underneath (or outside of)
-the source directory.
-
-Linux command line example:
-
-$ cd /path/to/codec2
-$ mkdir build_linux
-$ cd build_linux
-$ cmake ../ (defaults to /usr/local, use CMAKE_INSTALL_PREFIX to override)
-(if no errors)
-$ make
-(as root)
-$ make install
-
-=====================
-Win32
-=====================
-
-Install MinGW & the mysys shell
-   + pwd -W prints true Win32 directory
-   + I also installed emacs, "tortise svn", and "cmake", and built and installed speex
-
-$ cd codec2-dev
-$ mkdir build_win32
-$ cd build_win32
-$ cmake -DSPEEXDSP_INCLUDE_DIR=/usr/local/include/ -G "MSYS Makefiles" ..
-$ make
-- 
2.25.1