From b2c13f029a985dcb1b275c8485015fc6031a30c6 Mon Sep 17 00:00:00 2001 From: hobbes1069 Date: Tue, 17 Mar 2015 13:12:40 +0000 Subject: [PATCH] Updates to documentation git-svn-id: https://svn.code.sf.net/p/freetel/code@2080 01035d8c-6547-0410-b346-abe4f91aad63 --- codec2/INSTALL | 43 +++++++++++++++++++++++++++++++++++++++++++ codec2/README | 1 + codec2/README.cmake | 27 --------------------------- 3 files changed, 44 insertions(+), 27 deletions(-) delete mode 100644 codec2/README.cmake diff --git a/codec2/INSTALL b/codec2/INSTALL index e69de29b..d0cff595 100644 --- a/codec2/INSTALL +++ b/codec2/INSTALL @@ -0,0 +1,43 @@ +Installation Instructions for codec2 +------------------------------------ + +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. + +1/ Builds against system libraries by default. +2/ 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 +----------------------- + +Out-of-source builds are preferred. To build codec2, 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 + +Codec2 installs to /usr/local by defailt on *nix systems but can be overriden +by passing options to cmake during configuration. + +Some options that may be of interest: + 1/ CMAKE_INSTALL_PREFIX: Defaults to /usr/local + 2/ CMAKE_BUILD_TYPE: Defaults to Release + 3/ CMAKE_C_FLAGS: Additional build flags. + +These can be modified on the command line by using the "-D" option when running +cmake: + + $ cmake -DCMAKE_INSTALL_PREFIX=/usr diff --git a/codec2/README b/codec2/README index 4a355f65..e4a42fce 100644 --- a/codec2/README +++ b/codec2/README @@ -12,6 +12,7 @@ Quickstart ---------- 1/ Listen to Codec 2: + $ cd codec2 $ mkdir build_linux $ cmake ../ && make diff --git a/codec2/README.cmake b/codec2/README.cmake deleted file mode 100644 index b207511e..00000000 --- a/codec2/README.cmake +++ /dev/null @@ -1,27 +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 -- 2.25.1