Skip to content

Commit

Permalink
Add logo to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dancazarin committed Dec 5, 2019
1 parent 1e275cb commit 8e7d167
Show file tree
Hide file tree
Showing 3 changed files with 597 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# KFR - Fast, modern C++ DSP framework

<p align="center">
<img width="300" height="auto" src="img/KFR1.png">
</p>


![Build Status](https://img.shields.io/azure-devops/build/dlevin256/dlevin256/1/master.svg?style=flat-square)
[![Gitter](https://img.shields.io/gitter/room/kfrlib/kfr.svg?maxAge=2592000&style=flat-square)](https://gitter.im/kfrlib/kfr) ![License](https://img.shields.io/github/license/kfrlib/kfr.svg?style=flat-square)

Expand Down Expand Up @@ -314,6 +319,17 @@ cmake -GNinja -DENABLE_TESTS=ON -DCMAKE_BUILD_TYPE=Release ..
ninja
```

## Documentation

Documentation home:

https://www.kfrlib.com/newdocs/

Built with
* [cxxdox - generates markdown docs from C++](https://github.com/kfrlib/cxxdox)
* [mkdocs - static documentation generator](https://www.mkdocs.org/)
* [mkdocs-material - material theme for mkdocs](https://squidfunk.github.io/mkdocs-material/)

## Branches

`dev` - current development version. Pull requests should go to `dev`.
Expand All @@ -335,6 +351,7 @@ 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
Expand Down
Loading

0 comments on commit 8e7d167

Please sign in to comment.