Update README.md

slarew · Nov 19, 2018 · c874e77 · c874e77
1 parent a3966d1
commit c874e77
Show file tree

Hide file tree

Showing 2 changed files with 176 additions and 38 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -37,13 +37,6 @@ endif()
 # Include list of source files
 include(sources.cmake)
 
-add_library(kfr INTERFACE)
-target_sources(kfr INTERFACE ${KFR_SRC})
-target_include_directories(kfr INTERFACE include)
-
-add_library(kfr_dft include/kfr/dft/dft-src.cpp)
-target_link_libraries(kfr_dft kfr)
-
 add_definitions(-D_ENABLE_EXTENDED_ALIGNED_STORAGE)
 
 option(ENABLE_TESTS "Enable tests and examples. This changes many compiler flags" OFF)
@@ -91,3 +84,10 @@ if (ENABLE_TESTS)
     add_subdirectory(examples)
     add_subdirectory(tests)
 endif ()
+
+add_library(kfr INTERFACE)
+target_sources(kfr INTERFACE ${KFR_SRC})
+target_include_directories(kfr INTERFACE include)
+
+add_library(kfr_dft include/kfr/dft/dft-src.cpp)
+target_link_libraries(kfr_dft kfr)
diff --git a/README.md b/README.md
@@ -8,6 +8,8 @@ KFR is an open source C++ DSP framework that focuses on high performance (see be
 
 KFR is a header-only library (except DFT) and has no external dependencies.
 
+# Features
+
 ## What's new in KFR 3.0
 
 * Full AVX-512 support
@@ -17,7 +19,7 @@ KFR is a header-only library (except DFT) and has no external dependencies.
 * Number of automatic tests has been increased
 * GPL version changed from 3 to 2
 
-## Features
+## All features
 
 * All code in the library is optimized for Intel, AMD (SSE2, SSE3, SSE4.x, AVX and AVX2 and AVX512) and ARM (NEON) processors
 * Mathematical and statistical functions
@@ -27,7 +29,7 @@ KFR is a header-only library (except DFT) and has no external dependencies.
 * Most of the standard library functions are re-implemented to support vector of any length and data type
 * Runtime cpu detection
 
-Included DSP/audio algorithms:
+### Included DSP/audio algorithms:
 
 * FFT
 * Convolution
@@ -44,69 +46,201 @@ Included DSP/audio algorithms:
 * Pseudorandom number generator
 * Sorting
 * Ring (Circular) buffer
-* Waveshaper
+* Simple waveshaper
 * Fast incremental sine/cosine generation
 * EBU R128
 
-## Benchmark results
-### FFT
+# Benchmark results
+## FFT
 
 FFT (double precision, sizes from 1024 to 16777216)
 See [fft benchmark](https://github.com/kfrlib/fft-benchmark) for details about benchmarking process.
 
 ![FFT Performance](img/fft_performance.png)
 
-### Biquad
+## Biquad
 
 [Biquad performance](https://github.com/kfrlib/biquad-benchmark/blob/master/bq.svg)
 
-## Prerequisites
+# Usage
 
-* macOS: XCode 8.x, 9.x or 10.x
-* Windows
-  * MinGW 5.4 and Clang 4.0 or newer
-  * Visual Studio 2017 and latest Clang (LLVM toolkit)
-* Ubuntu: GCC 5.4 and Clang 4.0 or newer
-* CoMeta metaprogramming library (already included)
 
-KFR is a header-only so just `#include <kfr/all.hpp>` to start using it
 
-The following tools are required to build the examples:
+## Common prerequisites
 
-* CMake 3.0 or newer
+* CMake 3.0 or newer for building tests and examples
+* Python 2.7 or 3.x for building examples
+* (Optional) Ninja (https://ninja-build.org/)
 
-To build the tests:
+For running examples and plotting frequency responses of filters the following python packages are required:
+
+```bash
+pip install matplotlib
+pip install numpy
+pip install scipy
+```
+Or download prebuilt python packages for windows
 
-* Testo - C++14 testing micro framework (included)
-* Python 2.7 with the following modules:
+To obtain the full code, including examples and tests, you can clone the git repository:
 
-  * matplotlib
-  * numpy
-  * scipy
+```
+git clone https://github.com/kfrlib/kfr.git
+```
 
-## Installation
+## Including in CMake project
 
-To obtain the full code, including examples and tests, you can clone the git repository:
+CMakeLists.txt contains two libraries:
+* `kfr` - header only interface library
+* `kfr_dft` - static library for DFT and related algorithms
+
+```cmake
+# Include KFR subdirectory
+add_subdirectory(kfr)
+
+# Add header-only KFR to your executable or library, this sets include directories etc
+target_link_libraries(your_executable_or_library kfr)
 
+# Add KFR DFT to your executable or library, (cpp file will be built for this)
+target_link_libraries(your_executable_or_library kfr_dft)
 ```
-git clone https://github.com/kfrlib/kfr.git
+
+## Makefile, command line etc
+
+```bash
+# Add this to command line
+-Ipath_to_kfr/include
+```
+
+## Linux
+
+### Prerequisites
+* GCC 5.4 or newer
+* Clang 4.0 or newer
+
+### Command line
+```bash
+cd <path_to_kfr>
+mkdir build && cd build
+cmake -DENABLE_TESTS=ON -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_BUILD_TYPE=Release ..
+make -- -j
+```
+Or using Ninja
+```bash
+cd <path_to_kfr>
+mkdir build && cd build
+cmake -GNinja -DENABLE_TESTS=ON -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_BUILD_TYPE=Release ..
+ninja
+```
+
+## macOS
+
+### Prerequisites
+* XCode 8.3, 9.x or 10.x
+
+### Command line
+Using Xcode project:
+```bash
+cd <path_to_kfr>
+mkdir build && cd build
+cmake -GXcode -DENABLE_TESTS=ON -DCMAKE_BUILD_TYPE=Release ..
+cmake --build .
 ```
+Using Unix Makefiles:
+```bash
+cd <path_to_kfr>
+mkdir build && cd build
+cmake -G"Unix Makefiles" -DENABLE_TESTS=ON -DCMAKE_BUILD_TYPE=Release ..
+make -- -j
+```
+Or using Ninja:
+```bash
+cd <path_to_kfr>
+mkdir build && cd build
+cmake -GNinja -DENABLE_TESTS=ON -DCMAKE_BUILD_TYPE=Release ..
+ninja
+```
+
+## Visual Studio
+
+### Prerequisites
+* Visual Studio 2017
+* Latest Clang (http://llvm.org/)
+* Ninja is highly recommended because Visual Studio does not support parallel build with Clang at this moment.
+
+### Visual Studio IDE
+
+To work with KFR in Visual Studio you must add the path to the `include` directory inside KFR directory to the list of the project's include directories.<br>
+More details:
+https://docs.microsoft.com/en-us/cpp/ide/vcpp-directories-property-page?view=vs-2017
 
-To be able to run the tests and examples install the following python modules:
+Make sure that LLVM toolset is set for the project<br>
 
+Download and install official LLVM extension:
+* LLVM toolchain for Visual Studio https://marketplace.visualstudio.com/items?itemName=LLVMExtensions.llvm-toolchain
+
+More details:
+https://docs.microsoft.com/en-us/cpp/ide/general-property-page-project?view=vs-2017
+
+LLVM/Clang has very good compatibility with MSVC ABI and it's widely used for building large projects on Windows (including Chrome), so switching to LLVM/Clang should not cause compatibility problems.
+
+### Command line
+Using Ninja:
+```
+cd <path_to_kfr>
+mkdir build && cd build
+call "C:\<path to your Visual Studio installation>\VC\Auxiliary\Build\vcvars64.bat"
+cmake -GNinja -DENABLE_TESTS=ON -DCMAKE_CXX_COMPILER="C:/Program Files/LLVM/bin/clang-cl.exe" -DCMAKE_CXX_FLAGS=-m64 -DCMAKE_BUILD_TYPE=Release ..
+ninja
+```
+Or generate Visual Studio solution (building will be slower):
 ```
-pip install matplotlib # or download prebuilt package for windows
-pip install numpy # or download prebuilt package for windows
-pip install scipy # or download prebuilt package for windows
+cd <path_to_kfr>
+mkdir build && cd build
+cmake -G"Visual Studio 15 2017 Win64" -DENABLE_TESTS=ON -Tllvm -DCMAKE_BUILD_TYPE=Release ..
+```
+
+## MinGW/MSYS
+
+### Prerequisites
+* Latest MinGW or MSYS2
+* Clang 4.0 or newer
+
+Using Makefiles:
+```
+cd <path_to_kfr>
+mkdir build && cd build
+cmake -DENABLE_TESTS=ON -DCMAKE_BUILD_TYPE=Release ..
+make -- -j
+```
+Using Ninja:
+```
+cd <path_to_kfr>
+mkdir build && cd build
+cmake -GNinja -DENABLE_TESTS=ON -DCMAKE_BUILD_TYPE=Release ..
+ninja
 ```
 
 ## Tests
 
-Execute `build.py` or `build-cl.py` (Visual Studio version) to run the tests or run tests manually from the `tests` directory
+Every commit is tested in various OS, compilers, compiler settings etc.
+
+You can run the tests using these commands:
+
+```bash
+cd <path_to_cmake_build_directory>
+cd tests
+ctest -V
+```
 
 Tested on the following systems:
 
 ### macOS
+* (**Intel AVX2**) macOS **10.13.6** / Xcode 10 / AppleClang 10.0.0.10001145
+* (**Intel AVX** Azure Pipelines) macOS **10.13.6** / Xcode 10.1 / AppleClang 10.0.0.10001145
+* (**Intel AVX** Azure Pipelines) macOS **10.13.6** / Xcode 10 / AppleClang 10.0.0.10001145
+* (**Intel AVX** Azure Pipelines) macOS **10.13.6** / Xcode 9.4.1 / AppleClang 9.1.0.9020039
+* (**Intel AVX** Azure Pipelines) macOS **10.13.6** / Xcode 9.0.1 / AppleClang 9.0.0.9000038
+* (**Intel AVX** Azure Pipelines) macOS **10.13.6** / Xcode 8.3.3 / AppleClang 8.1.0.8020042
 * (**Intel AVX2**) macOS **10.11.6** / Xcode 7.3 / AppleClang 7.3.0.7030031
 * (**Intel AVX2**) macOS **10.11.4** / Xcode 7.3 / AppleClang 7.3.0.7030031
 * (**ARMv7, ARMv7s, ARM64**) macOS **10.11.6** / Xcode 7.3 / AppleClang 7.3.0.7030031
@@ -120,6 +254,7 @@ Tested on the following systems:
 * (**SSE4.2** Travis-CI) macOS **10.10.3** / Xcode 6.3 / AppleClang 6.1.0.6020049
 
 ### Ubuntu
+* (**Intel AVX2**) Ubuntu **18.04** / gcc-7.x / clang version 7.0.0 (tags/RELEASE_700/final)
 * (**Intel AVX2**) Ubuntu **16.04** / gcc-5.4.0 / clang version 3.8.0 (tags/RELEASE_380/final)
 * (**ARMv7 NEON**) Ubuntu **16.04** / gcc-5.4.0 / clang version 3.8.0 (tags/RELEASE_380/final)
 * (**ARMv7 NEON**) Ubuntu **14.04** / gcc-4.8.4 / clang version 3.8.0 (tags/RELEASE_380/final)
@@ -128,12 +263,15 @@ Tested on the following systems:
 * (**Intel AVX2** Travis-CI) Ubuntu **14.04** / gcc-5.3.0 (Ubuntu 5.3.0-3ubuntu1~14.04) 5.3.0 20151204 / clang version 3.8.0 (tags/RELEASE_380/final)
 
 ### Windows
+* (**Intel AVX512**) Windows **10** / Visual Studio 2017 / Clang 7.0
+* (**Intel AVX512**) Windows **10** / Visual Studio 2017 / Clang 6.0
 * (**Intel AVX2**) Windows **10** / MinGW-W64 5.2 / clang version 3.8.0 (branches/release_38)
 * (**Intel AVX2**) Windows **10** / MinGW-W64 4.8 / clang version 3.8.0 (branches/release_38)
 * (**Intel AVX**) Windows **8.1** / MinGW-W64 5.4 / clang version 3.8.0 (branches/release_38)
-* (**Intel AVX**) Windows **8.1** / Visual Studio Update 2 / clang version 3.9.0 (SVN r273898 (27 June 2016))
+* (**Intel AVX**) Windows **8.1** / Visual Studio 2015 Update 2 / clang version 3.9.0 (SVN r273898 (27 June 2016))
 
 ### Linux on Windows 10
+* (**Intel AVX2**) Windows **10.0.17134.407** compatible with Ubuntu **18.04** / gcc-7.x / clang version 7.0.0 (tags/RELEASE_700/final)
 * (**Intel AVX2**) Windows **10.0.14393** compatible with Ubuntu **14.04** / gcc-5.4.0 / clang version 3.8.0 (tags/RELEASE_380/final)
 
 ## Planned for future versions