From ea43b8878719cf4d67201e724c9978078cf9cc29 Mon Sep 17 00:00:00 2001 From: gregory guy Date: Thu, 5 Mar 2020 15:39:33 +0100 Subject: [PATCH] Cleanup the CMakeLists.txt file. Provide basic cmake build instructions. Write the README file. Delete empty file NEWS. Signed-off-by: gregory guy (cherry picked from commit 644ea12784290be3d8a71a3b60de2706983dc9c2) --- CMakeLists.txt | 55 ++++++++------- INSTALL | 179 +++++-------------------------------------------- NEWS | 0 README | 28 ++++++++ 4 files changed, 75 insertions(+), 187 deletions(-) delete mode 100644 NEWS diff --git a/CMakeLists.txt b/CMakeLists.txt index af29731..74b3bde 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -9,17 +9,17 @@ # ################################################# -cmake_minimum_required( VERSION 2.6 ) +cmake_minimum_required( VERSION 2.8 ) -##### general package setup ##################### +##### general package setup project( akode ) set( PACKAGE akode ) set( VERSION R14.0.7 ) -##### include essential cmake modules ########### +##### include essential cmake modules include( FindPkgConfig ) include( CheckCXXSourceCompiles ) @@ -29,46 +29,53 @@ include( CheckIncludeFile ) include( CheckLibraryExists ) -##### include our cmake modules ################# +##### include our cmake modules set( CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake/modules" ) include( TDEMacros ) -##### setup install paths ####################### +##### setup install paths include( TDESetupPaths ) tde_setup_paths( ) -##### optional stuff ############################ - -option( WITH_ALL_OPTIONS "Enable all optional support" OFF ) +##### optional stuff +option( WITH_ALL_OPTIONS "Enable all optional support" OFF ) option( WITH_GCC_VISIBILITY "Enable fvisibility and fvisibility-inlines-hidden" ${WITH_ALL_OPTIONS} ) -OPTION( WITH_LIBLTDL "Build with libltdl" ${WITH_ALL_OPTIONS} ) - -OPTION( WITH_ALSA_SINK "Build with alsa sink" ${WITH_ALL_OPTIONS} ) -OPTION( WITH_JACK_SINK "Build with jack sink" ${WITH_ALL_OPTIONS} ) -OPTION( WITH_PULSE_SINK "Build with pulseaudio sink" OFF ) -OPTION( WITH_OSS_SINK "Build with oss sink" ${WITH_ALL_OPTIONS} ) -OPTION( WITH_SUN_SINK "Build with sun sink" OFF ) -OPTION( WITH_FFMPEG_DECODER "Build with ffmeeg decoder" OFF ) -option( WITH_MPC_DECODER "Build with mpc decoder" ON ) -option( WITH_MPEG_DECODER "Build with mpeg decoder" ${WITH_ALL_OPTIONS} ) -OPTION( WITH_SRC_RESAMPLER "Build with src resampler" ${WITH_ALL_OPTIONS} ) -option( WITH_XIPH_DECODER "Build with xiph decoder" ${WITH_ALL_OPTIONS} ) +OPTION( WITH_LIBLTDL "Build with libltdl" OFF ) +OPTION( WITH_ALSA_SINK "Build with alsa sink" ${WITH_ALL_OPTIONS} ) +OPTION( WITH_JACK_SINK "Build with jack sink" ${WITH_ALL_OPTIONS} ) +OPTION( WITH_PULSE_SINK "Build with pulseaudio sink" ${WITH_ALL_OPTIONS} ) +OPTION( WITH_OSS_SINK "Build with oss sink" ${WITH_ALL_OPTIONS} ) +OPTION( WITH_SUN_SINK "Build with sun sink" OFF ) +OPTION( WITH_FFMPEG_DECODER "Build with ffmpeg decoder" OFF ) +option( WITH_MPC_DECODER "Build with mpc decoder" ${WITH_ALL_OPTIONS} ) +option( WITH_MPEG_DECODER "Build with mpeg decoder" ${WITH_ALL_OPTIONS} ) +OPTION( WITH_SRC_RESAMPLER "Build with src resampler" ${WITH_ALL_OPTIONS} ) +option( WITH_XIPH_DECODER "Build with xiph decoder" ${WITH_ALL_OPTIONS} ) -##### configure checks ########################## +##### configure checks include( ConfigureChecks.cmake ) + + +###### global compiler settings + add_definitions( -DHAVE_CONFIG_H ) -configure_file( config.h.cmake config.h @ONLY ) +set( CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--no-undefined" ) + + +##### source directories -##### build ##################################### +add_subdirectory( ${PROJECT_NAME} ) -tde_auto_add_subdirectories() +##### write configure files + +configure_file( config.h.cmake config.h @ONLY ) diff --git a/INSTALL b/INSTALL index 7285007..a3336cd 100644 --- a/INSTALL +++ b/INSTALL @@ -1,171 +1,24 @@ -**** NOTE **** -The instructions below may be outdated. -Please see https://wiki.trinitydesktop.org/How_to_Build_TDE_Core_Modules for the latest build information. - Basic Installation ================== - These are generic installation instructions. - - The `configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a `Makefile' in each directory of the package. -It may also create one or more `.h' files containing system-dependent -definitions. Finally, it creates a shell script `config.status' that -you can run in the future to recreate the current configuration, a file -`config.cache' that saves the results of its tests to speed up -reconfiguring, and a file `config.log' containing compiler output -(useful mainly for debugging `configure'). - - If you need to do unusual things to compile the package, please try -to figure out how `configure' could check whether to do them, and mail -diffs or instructions to the address given in the `README' so they can -be considered for the next release. If at some point `config.cache' -contains results you don't want to keep, you may remove or edit it. - - The file `configure.in' is used to create `configure' by a program -called `autoconf'. You only need `configure.in' if you want to change -it or regenerate `configure' using a newer version of `autoconf'. - -The simplest way to compile this package is: - - 1. `cd' to the directory containing the package's source code and type - `./configure' to configure the package for your system. If you're - using `csh' on an old version of System V, you might need to type - `sh ./configure' instead to prevent `csh' from trying to execute - `configure' itself. - - Running `configure' takes a while. While running, it prints some - messages telling which features it is checking for. - - 2. Type `make' to compile the package. - - 3. Type `make install' to install the programs and any data files and - documentation. - - 4. You can remove the program binaries and object files from the - source code directory by typing `make clean'. - -Compilers and Options -===================== - - Some systems require unusual options for compilation or linking that -the `configure' script does not know about. You can give `configure' -initial values for variables by setting them in the environment. Using -a Bourne-compatible shell, you can do that on the command line like -this: - CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure - -Or on systems that have the `env' program, you can do it like this: - env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure - -Compiling For Multiple Architectures -==================================== - - You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you must use a version of `make' that -supports the `VPATH' variable, such as GNU `make'. `cd' to the -directory where you want the object files and executables to go and run -the `configure' script. `configure' automatically checks for the -source code in the directory that `configure' is in and in `..'. - - If you have to use a `make' that does not supports the `VPATH' -variable, you have to compile the package for one architecture at a time -in the source code directory. After you have installed the package for -one architecture, use `make distclean' before reconfiguring for another -architecture. - -Installation Names -================== - - By default, `make install' will install the package's files in -`/usr/local/bin', `/usr/local/man', etc. You can specify an -installation prefix other than `/usr/local' by giving `configure' the -option `--prefix=PATH'. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -give `configure' the option `--exec-prefix=PATH', the package will use -PATH as the prefix for installing programs and libraries. -Documentation and other data files will still use the regular prefix. - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving `configure' the -option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. - -Optional Features -================= - - Some packages pay attention to `--enable-FEATURE' options to -`configure', where FEATURE indicates an optional part of the package. -They may also pay attention to `--with-PACKAGE' options, where PACKAGE -is something like `gnu-as' or `x' (for the X Window System). The -`README' should mention any `--enable-' and `--with-' options that the -package recognizes. - - For packages that use the X Window System, `configure' can usually -find the X include and library files automatically, but if it doesn't, -you can use the `configure' options `--x-includes=DIR' and -`--x-libraries=DIR' to specify their locations. - -Specifying the System Type -========================== - - There may be some features `configure' can not figure out -automatically, but needs to determine by the type of host the package -will run on. Usually `configure' can figure that out, but if it prints -a message saying it can not guess the host type, give it the -`--host=TYPE' option. TYPE can either be a short name for the system -type, such as `sun4', or a canonical name with three fields: - CPU-COMPANY-SYSTEM - -See the file `config.sub' for the possible values of each field. If -`config.sub' isn't included in this package, then this package doesn't -need to know the host type. - - If you are building compiler tools for cross-compiling, you can also -use the `--target=TYPE' option to select the type of system they will -produce code for and the `--build=TYPE' option to select the type of -system on which you are compiling the package. - -Sharing Defaults -================ - - If you want to set default values for `configure' scripts to share, -you can create a site shell script called `config.site' that gives -default values for variables like `CC', `cache_file', and `prefix'. -`configure' looks for `PREFIX/share/config.site' if it exists, then -`PREFIX/etc/config.site' if it exists. Or, you can set the -`CONFIG_SITE' environment variable to the location of the site script. -A warning: not all `configure' scripts look for a site script. - -Operation Controls -================== - - `configure' recognizes the following options to control how it -operates. - -`--cache-file=FILE' - Use and save the results of the tests in FILE instead of - `./config.cache'. Set FILE to `/dev/null' to disable caching, for - debugging `configure'. - -`--help' - Print a summary of the options to `configure', and exit. +aKode relies on cmake to build. -`--quiet' -`--silent' -`-q' - Do not print messages saying which checks are being made. +Here are suggested default options: -`--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - `configure' can determine that directory automatically. + -DCMAKE_BUILD_TYPE=RelWithDebInfo \ + -DCMAKE_VERBOSE_MAKEFILE="ON" \ + -DCMAKE_SKIP_RPATH="OFF" \ + -DWITH_ALL_OPTIONS="ON" -`--version' - Print the version of Autoconf used to generate the `configure' - script, and exit. -`configure' also accepts some other, not widely useful, options. +Optional: +========= + - Alsa + - PulseAudio + - Flac + - Libmad + - Libogg/Libvorbis + - Speex + - Lisamplerate + - JACK Audio Connection Kit diff --git a/NEWS b/NEWS deleted file mode 100644 index e69de29..0000000 diff --git a/README b/README index 8b13789..80f0300 100644 --- a/README +++ b/README @@ -1 +1,29 @@ +akode - an audio library for aRts (tde) + + +aKode is a multithreaded audio library that provides aRts with +plugins to play a variety of formats: + +- Ogg Vorbis +- Musepack (MPC) +- FLAC +- Speex +- Libmad (MPEG-1 and MPEG-2) +- Libsamplerate + +aKode focuses on performance, which means a big enhancement for users +runing aRts in non-realtime mode. + + + + CONTRIBUTING +============== + +If you wish to contribute to aKode (TDE), you might do so: + +- TDE Gitea Workspace (TGW) collaboration tool. + https://mirror.git.trinitydesktop.org/gitea + +- TDE Weblate Translation Workspace (TWTW) collaboration tool. + https://mirror.git.trinitydesktop.org/weblate