aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhayati ayguen <h_ayguen@web.de>2020-03-29 08:40:47 +0200
committerhayati ayguen <h_ayguen@web.de>2020-03-29 08:40:47 +0200
commit6e6120951fab9a7bbbf9f604bd028ddc01de5729 (patch)
treeec187ec40ca79444b927fd16163b0a0f56611bb1 /README.md
parentc974c1d9e336bdd790260d96044207424384613c (diff)
downloadpffft-6e6120951fab9a7bbbf9f604bd028ddc01de5729.tar.gz
update README and C standard: C99 doesn't require gcc extensions
Signed-off-by: hayati ayguen <h_ayguen@web.de>
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index 211dca1..27dd530 100644
--- a/README.md
+++ b/README.md
@@ -67,23 +67,30 @@ more code than I planned..
## The code:
-Good old C:
-FFT API is very very simple, just make sure that you read the comments in `pffft.h`.
-Fast convolution API is also very simple, just make sure that you read the comments
+### Good old C:
+The FFT API is very very simple, just make sure that you read the comments in `pffft.h`.
+
+The Fast convolution's API is also very simple, just make sure that you read the comments
in `pffastconv.h`.
+### C++:
+A simple C++ wrapper is available in `pffft.hpp`.
-C++: a simple C++ wrapper is available in `pffft.hpp`.
+### Git:
This archive's source can be downloaded with git including the submodules:
-
```
-git clone --recursive https://github.com/hayguen/pffft.git`
+git clone --recursive https://github.com/hayguen/pffft.git
```
With `--recursive` the submodules for Green and Kiss-FFT are also fetched,
to use them in the benchmark. You can omit the `--recursive`-option.
+For retrieving the submodules later:
+```
+git submodule update --init
+```
+
## CMake:
There's now CMake support to build the static libraries `libPFFFT.a`