#
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)
+==========================
+ 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
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
1/ Listen to Codec 2:
- $ cd codec2
+ $ cd codec2-dev
$ mkdir build_linux
$ cd build_linux
$ cmake ..
+++ /dev/null
-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