commit 8e7d167c3de92cb340d156b9bd587b09cce9d990 parent 1e275cb3bb289bcb802d2264cd0d6f6e01d03a04 Author: [email protected] <[email protected]> Date: Thu, 5 Dec 2019 22:31:36 +0000 Add logo to README.md Diffstat:
| M | README.md | | | 17 | +++++++++++++++++ |
| A | img/KFR.svg | | | 580 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | img/KFR1.png | | | 0 |
3 files changed, 597 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -1,5 +1,10 @@ # KFR - Fast, modern C++ DSP framework +<p align="center"> + <img width="300" height="auto" src="img/KFR1.png"> +</p> + +  [](https://gitter.im/kfrlib/kfr)  @@ -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`. @@ -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 diff --git a/img/KFR.svg b/img/KFR.svg @@ -0,0 +1,580 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" + "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> +<!-- Created with matplotlib (https://matplotlib.org/) --> +<svg height="576pt" version="1.1" viewBox="0 0 576 576" width="576pt" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"> + <defs> + <style type="text/css"> +*{stroke-linecap:butt;stroke-linejoin:round;} + </style> + </defs> + <g id="figure_1"> + <g id="patch_1"> + <path d="M 0 576 +L 576 576 +L 576 0 +L 0 0 +z +" style="fill:#ffffff;"/> + </g> + <g id="axes_1"> + <g id="line2d_1"> + <path clip-path="url(#p33de444e30)" d="M 295.2 290.88 +L 330.388248 244.448765 +L 348.735317 220.616788 +L 363.651295 201.596899 +L 376.546434 185.506255 +L 387.980084 171.587751 +L 398.267108 159.409168 +L 407.60128 148.698129 +L 416.066936 139.315477 +L 423.794971 131.074799 +L 430.861319 123.857079 +L 437.338126 117.552337 +L 443.251233 112.098734 +L 448.668252 107.397601 +L 453.613003 103.392952 +L 458.146639 100.00139 +L 462.289526 97.175651 +L 466.029764 94.886845 +L 469.455965 93.046153 +L 472.554961 91.628774 +L 475.376048 90.579338 +L 477.909227 89.868023 +L 480.225304 89.444469 +L 482.312451 89.283624 +L 484.208702 89.354591 +L 485.94629 89.637996 +L 487.532491 90.117884 +L 488.992634 90.788367 +L 490.346668 91.653612 +L 491.609145 92.727609 +L 492.775181 94.016819 +L 493.839849 95.527504 +L 494.820056 97.310705 +L 495.701632 99.387921 +L 496.469879 101.780745 +L 497.109595 104.510725 +L 497.609376 107.632814 +L 497.947625 111.176704 +L 498.101939 115.171776 +L 498.049168 119.64678 +L 497.765494 124.629477 +L 497.226511 130.146263 +L 496.407332 136.221743 +L 495.282697 142.878278 +L 493.827114 150.135501 +L 492.029799 157.949164 +L 489.87244 166.323463 +L 487.337181 175.258977 +L 484.428741 184.68376 +L 481.137843 194.583147 +L 477.482832 204.866052 +L 473.463327 215.505091 +L 469.111192 226.394136 +L 464.434548 237.49707 +L 459.44212 248.777068 +L 454.143225 260.196714 +L 448.587606 271.637858 +L 442.83328 282.980784 +L 436.858425 294.268202 +L 430.724353 305.384139 +L 424.404974 316.375903 +L 417.964328 327.132482 +L 411.422162 337.626504 +L 404.797472 347.833562 +L 398.108476 357.732142 +L 391.372594 367.303546 +L 384.60643 376.531798 +L 377.825762 385.403541 +L 371.045537 393.907928 +L 364.279867 402.036499 +L 357.599959 409.717929 +L 350.903026 417.080677 +L 344.257941 424.055394 +L 337.67554 430.641887 +L 331.165867 436.841703 +L 324.738193 442.657994 +L 318.401036 448.095387 +L 312.101522 453.207685 +L 305.907134 457.948896 +L 299.824436 462.327244 +L 293.798448 466.391651 +L 287.895361 470.107078 +L 282.059203 473.518595 +L 276.35516 476.598149 +L 270.72653 479.3866 +L 265.17715 481.888439 +L 259.710572 484.108655 +L 254.389692 486.03248 +L 249.157186 487.691547 +L 244.015671 489.092077 +L 238.909021 490.252587 +L 233.89874 491.162486 +L 228.986799 491.828942 +L 224.174929 492.259368 +L 219.408161 492.462466 +L 214.745401 492.439637 +L 210.13252 492.194661 +L 205.626996 491.734752 +L 201.175675 491.058774 +L 196.781252 490.167456 +L 192.446384 489.061755 +L 188.173695 487.742862 +L 183.965772 486.212195 +L 179.825159 484.4714 +L 175.70516 482.497305 +L 171.659246 480.312021 +L 167.642578 477.88785 +L 163.706909 475.252575 +L 159.809394 472.374079 +L 155.955628 469.248228 +L 152.194543 465.911325 +L 148.486586 462.324906 +L 144.837685 458.486083 +L 141.253912 454.392453 +L 137.741478 450.042136 +L 134.306727 445.433802 +L 130.95613 440.566707 +L 127.696275 435.440729 +L 124.500948 429.998045 +L 121.412833 424.294053 +L 118.438955 418.330887 +L 115.586421 412.111456 +L 112.862412 405.639468 +L 110.274167 398.91947 +L 107.805619 391.887086 +L 105.49092 384.6152 +L 103.337523 377.111343 +L 101.352881 369.38401 +L 99.544428 361.442682 +L 97.919566 353.297847 +L 96.497966 345.038689 +L 95.270691 336.601801 +L 94.244838 328.000341 +L 93.433846 319.328327 +L 92.834121 310.521989 +L 92.454752 301.677629 +L 92.296152 292.812368 +L 92.358495 283.943367 +L 92.641712 275.087794 +L 93.145496 266.262789 +L 93.869296 257.485435 +L 94.802768 248.851587 +L 95.950504 240.297621 +L 97.297829 231.916904 +L 98.852884 223.64621 +L 100.596793 215.575767 +L 102.522111 207.716701 +L 104.62135 200.07911 +L 106.886998 192.672085 +L 109.311529 185.503729 +L 111.887427 178.58118 +L 114.607196 171.910633 +L 117.434021 165.56053 +L 120.386727 159.468065 +L 123.458098 153.636565 +L 126.640997 148.068557 +L 129.928372 142.765801 +L 133.313274 137.729325 +L 136.750827 133.009592 +L 140.269756 128.551437 +L 143.863591 124.353775 +L 147.525989 120.414946 +L 151.250748 116.732746 +L 155.031807 113.304463 +L 158.863255 110.126907 +L 162.785449 107.163226 +L 166.74865 104.447598 +L 170.747288 101.975614 +L 174.824955 99.716876 +L 178.929167 97.696976 +L 183.105465 95.88999 +L 187.299702 94.315806 +L 191.559232 92.953074 +L 195.881478 91.803261 +L 200.263825 90.867603 +L 204.703621 90.147108 +L 209.198178 89.642549 +L 213.744778 89.354471 +L 218.397009 89.283651 +L 223.096856 89.435019 +L 227.898829 89.814257 +L 232.743539 90.42047 +L 237.686283 91.264242 +L 242.725223 92.352758 +L 247.79909 93.676179 +L 252.964045 95.252408 +L 258.217621 97.087735 +L 263.557097 99.188108 +L 268.979491 101.559097 +L 274.542108 104.23632 +L 280.181165 107.199496 +L 285.892721 110.452788 +L 291.733405 114.038512 +L 297.637832 117.926386 +L 303.601016 122.118699 +L 309.678376 126.663805 +L 315.863824 131.570406 +L 322.090261 136.794151 +L 328.411134 142.388448 +L 334.818466 148.358667 +L 341.303548 154.708807 +L 347.79813 161.379554 +L 354.351907 168.429056 +L 360.954097 175.856696 +L 367.593132 183.660014 +L 374.256644 191.834573 +L 380.931457 200.373833 +L 387.657768 209.342771 +L 394.364437 218.659594 +L 401.035564 228.310226 +L 407.654436 238.27797 +L 414.203537 248.543408 +L 420.664566 259.084318 +L 427.018461 269.875591 +L 433.245423 280.889177 +L 439.324953 292.094036 +L 445.235893 303.456112 +L 450.91745 314.858265 +L 456.353456 326.262469 +L 461.56265 337.707824 +L 466.457095 348.995693 +L 471.057905 360.16385 +L 475.321396 371.095778 +L 479.213746 381.682212 +L 482.757952 391.963274 +L 485.905757 401.769732 +L 488.665966 411.084038 +L 491.048258 419.892192 +L 493.063095 428.183577 +L 494.710544 435.894784 +L 496.000754 442.977951 +L 496.966312 449.50074 +L 497.622309 455.428125 +L 497.994689 460.783873 +L 498.109052 465.55377 +L 497.994438 469.812149 +L 497.675065 473.588073 +L 497.174446 476.911525 +L 496.522931 479.784903 +L 495.728915 482.298159 +L 494.819254 484.450951 +L 493.814055 486.273732 +L 492.704605 487.830942 +L 491.515992 489.121995 +L 490.245063 490.180734 +L 488.882739 491.030841 +L 487.414367 491.686129 +L 485.840752 492.145961 +L 484.118363 492.414076 +L 482.263589 492.475304 +L 480.223469 492.315291 +L 478.013065 491.915895 +L 475.569574 491.243207 +L 472.906528 490.27534 +L 469.981603 488.971914 +L 466.778824 487.297897 +L 463.248143 485.196326 +L 459.368848 482.621312 +L 455.15783 479.554974 +L 450.521675 475.897838 +L 445.476533 471.629158 +L 439.960999 466.665063 +L 433.952214 460.951711 +L 427.428828 454.437878 +L 420.323535 447.025107 +L 412.564607 438.604629 +L 404.076781 429.059243 +L 394.782522 418.266101 +L 384.549104 406.034505 +L 373.239493 392.163549 +L 360.543781 376.232979 +L 346.025049 357.649072 +L 328.643966 335.02669 +L 304.93143 303.767682 +L 256.954128 240.450891 +L 239.315662 217.597042 +L 224.74267 199.069937 +L 212.124258 183.378224 +L 200.903427 169.77034 +L 190.768896 157.822391 +L 181.581628 147.328485 +L 173.207798 138.095074 +L 165.568482 129.995894 +L 158.587459 122.911365 +L 152.192428 116.731254 +L 146.315869 111.356443 +L 140.974727 106.765688 +L 136.064058 102.833058 +L 131.600152 99.537423 +L 127.523006 96.79863 +L 123.811639 94.56897 +L 120.444781 92.800875 +L 117.401087 91.447391 +L 114.631557 90.453871 +L 112.119775 89.784592 +L 109.849441 89.404648 +L 107.78114 89.280059 +L 105.903269 89.386023 +L 104.183792 89.703547 +L 102.615408 90.216647 +L 101.172996 90.919824 +L 99.836821 91.817635 +L 98.592552 92.924453 +L 97.445069 94.246699 +L 96.387112 95.810937 +L 95.428101 97.630894 +L 94.56858 99.745798 +L 93.823241 102.177153 +L 93.201509 104.977591 +L 92.724351 108.176935 +L 92.413581 111.804921 +L 92.291807 115.890908 +L 92.382368 120.46355 +L 92.709259 125.550434 +L 93.297042 131.177691 +L 94.170736 137.369563 +L 95.355708 144.147946 +L 96.864667 151.47363 +L 98.716145 159.353657 +L 100.928337 167.791779 +L 103.518967 176.788108 +L 106.482781 186.269826 +L 109.828922 196.221881 +L 113.538527 206.552484 +L 117.611851 217.233979 +L 122.016545 228.159746 +L 126.744391 239.293546 +L 131.786567 250.59845 +L 137.095502 261.957154 +L 142.655223 273.330127 +L 148.449689 284.679103 +L 154.462838 295.967185 +L 160.633066 307.078564 +L 166.939542 317.980791 +L 173.410802 328.723633 +L 179.981564 339.199586 +L 186.632859 349.384495 +L 193.346499 359.257103 +L 200.051331 368.724592 +L 206.782503 377.848912 +L 213.524556 386.617416 +L 220.262853 395.019909 +L 226.983587 403.048535 +L 233.673773 410.697649 +L 240.321245 417.963686 +L 246.914642 424.845038 +L 253.443398 431.341916 +L 259.957675 437.511574 +L 266.389115 443.297021 +L 272.729239 448.703009 +L 278.9703 453.735626 +L 285.166057 458.447022 +L 291.249485 462.795334 +L 297.275599 466.829269 +L 303.178233 470.514173 +L 309.01338 473.894878 +L 314.715893 476.943724 +L 320.342485 479.701313 +L 325.889335 482.172194 +L 331.293012 484.338741 +L 336.61079 486.234691 +L 341.839806 487.865945 +L 346.977464 489.238765 +L 352.021417 490.359739 +L 357.02755 491.244681 +L 361.935047 491.886374 +L 366.742192 492.292264 +L 371.503906 492.470788 +L 376.161354 492.423669 +L 380.768608 492.15442 +L 385.268268 491.670574 +L 389.713425 490.970728 +L 394.101389 490.055637 +L 398.429505 488.926283 +L 402.695153 487.583883 +L 406.895754 486.029879 +L 411.028763 484.265944 +L 415.140787 482.268652 +L 419.178449 480.060423 +L 423.18649 477.613313 +L 427.113258 474.955409 +L 431.001497 472.054356 +L 434.845604 468.906059 +L 438.596764 465.547115 +L 442.294415 461.938837 +L 445.932627 458.078379 +L 449.505328 453.963383 +L 453.006305 449.592012 +L 456.429214 444.962983 +L 459.767585 440.075602 +L 463.049041 434.873364 +L 466.229787 429.409003 +L 469.302896 423.683971 +L 472.261346 417.700459 +L 475.098034 411.461436 +L 477.805786 404.970671 +L 480.402248 398.164505 +L 482.851857 391.113299 +L 485.147186 383.823712 +L 487.280795 376.303345 +L 489.245244 368.560763 +L 491.033112 360.605513 +L 492.637012 352.448151 +L 494.049613 344.100247 +L 495.253488 335.653037 +L 496.255591 327.042954 +L 497.042727 318.364138 +L 497.618294 309.552791 +L 497.973447 300.7053 +L 498.1078 291.83879 +L 498.021207 282.970424 +L 497.713761 274.117369 +L 497.185798 265.296761 +L 496.437892 256.525674 +L 495.480633 247.899869 +L 494.309236 239.355755 +L 492.938615 230.986564 +L 491.360434 222.729132 +L 489.593808 214.673517 +L 487.646197 206.830769 +L 485.525105 199.210913 +L 483.238062 191.822963 +L 480.792605 184.674948 +L 478.196263 177.773927 +L 475.484482 171.190902 +L 472.639993 164.862289 +L 469.670084 158.792175 +L 466.581977 152.983821 +L 463.382816 147.439687 +L 460.079655 142.16147 +L 456.716299 137.202313 +L 453.265402 132.505681 +L 449.733561 128.071046 +L 446.127247 123.897272 +L 442.452802 119.982648 +L 438.716426 116.32492 +L 434.924178 112.921326 +L 431.081968 109.768633 +L 427.195553 106.86316 +L 423.223312 104.17039 +L 419.216014 101.721311 +L 415.129965 99.485764 +L 411.017748 97.489035 +L 406.833726 95.70545 +L 402.632139 94.154584 +L 398.365541 92.815344 +L 394.036516 91.689171 +L 389.647681 90.777276 +L 385.201693 90.08064 +L 380.701242 89.600013 +L 376.149052 89.335912 +L 371.491475 89.289382 +L 366.786599 89.465033 +L 361.979862 89.868814 +L 357.130719 90.499508 +L 352.18383 91.367961 +L 347.141046 92.481326 +L 342.063691 93.829445 +L 336.895571 95.430474 +L 331.639168 97.290667 +L 326.297217 99.415932 +L 320.812332 101.839801 +L 315.247786 104.54488 +L 309.60725 107.53579 +L 303.894684 110.816641 +L 298.053471 114.429978 +L 292.149025 118.345168 +L 286.125538 122.608835 +L 280.049351 127.183399 +L 273.865724 132.119189 +L 267.641762 137.371483 +L 261.324069 142.993874 +L 254.920655 148.991623 +L 248.440266 155.368616 +L 241.892393 162.127232 +L 235.287299 169.268217 +L 228.636031 176.79055 +L 221.950433 184.691313 +L 215.243161 192.965561 +L 208.527687 201.606194 +L 201.818305 210.603832 +L 195.130129 219.946695 +L 188.479095 229.620489 +L 181.881948 239.608297 +L 175.356231 249.890488 +L 168.92027 260.444622 +L 162.593148 271.245381 +L 156.394677 282.264512 +L 150.345366 293.470776 +L 144.466375 304.829931 +L 138.818255 316.224726 +L 133.380406 327.696354 +L 128.209917 339.124169 +L 123.355366 350.389736 +L 118.795848 361.5307 +L 114.574696 372.430774 +L 110.725351 382.981068 +L 107.247953 393.152136 +L 104.141755 402.916951 +L 101.423205 412.186523 +L 99.082527 420.947144 +L 97.122359 429.129808 +L 95.524264 436.736543 +L 94.269371 443.772994 +L 93.344693 450.198669 +L 92.724156 456.034966 +L 92.381966 461.305945 +L 92.292733 466.037838 +L 92.431595 470.258592 +L 92.770118 473.963697 +L 93.285264 477.223033 +L 93.954511 480.067076 +L 94.756178 482.526488 +L 95.66947 484.631846 +L 96.687109 486.43301 +L 97.794555 487.951945 +L 98.993319 489.224877 +L 100.274088 490.265839 +L 101.64606 491.09831 +L 103.12401 491.735896 +L 104.728103 492.182374 +L 106.461519 492.429673 +L 108.327352 492.469809 +L 110.378823 492.287929 +L 112.627268 491.859874 +L 115.084095 491.160964 +L 117.790266 490.153915 +L 120.761764 488.804111 +L 124.014633 487.076278 +L 127.564852 484.934721 +L 131.464158 482.318341 +L 135.733035 479.180987 +L 140.3916 475.476601 +L 145.500445 471.123661 +L 151.040597 466.106647 +L 157.118707 460.29594 +L 163.714857 453.676725 +L 170.896286 446.150592 +L 178.734583 437.609007 +L 187.304751 427.935269 +L 196.683926 417.007384 +L 207.00441 404.635577 +L 218.458876 390.550478 +L 231.303036 374.396948 +L 246.090226 355.432441 +L 263.923807 332.183832 +L 289.00089 299.09116 +L 295.148071 290.948792 +L 295.148071 290.948792 +" style="fill:none;stroke:#002878;stroke-linecap:square;stroke-width:5;"/> + </g> + </g> + </g> + <defs> + <clipPath id="p33de444e30"> + <rect height="443.52" width="446.4" x="72" y="69.12"/> + </clipPath> + </defs> +</svg> diff --git a/img/KFR1.png b/img/KFR1.png Binary files differ.
