Merge pull request #5 from Clonkk/devel

merge devel into master
SciNim · Nov 25, 2020 · 1258763 · 1258763
2 parents 608a434 + 88e0253
commit 1258763
Show file tree

Hide file tree

Showing 20 changed files with 4,825 additions and 1,460 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,3 @@
-tests/test1
+tests/bin/
 testresults/
 nimcache/
diff --git a/README.md b/README.md
@@ -3,12 +3,20 @@ Nim bindings to the FFTW3 library, to compute Fourier transforms of various kind
 # Installation
 
 Use nimble `nimble install fftw3` to install the latest released version
+To generate the documentation locally use ``nimble doc --project src/fftw3.nim``
 
 # Usage
 
-I advise to read the fftw documentation :
+Read the documentation here with the complete API and examples : https://clonkk.github.io/nimfftw3/
 
-You can find the documentation here with the complete API and examples : https://clonkk.github.io/nimfftw3/
+If you don't know how to use FFTW, read the official FFTW's documentation : http://www.fftw.org/fftw3_doc/
+
+# Contributing and evolution
+
+Any help and contribution is welcomed !
+
+As much as possible, breaking change in API should be avoided.
+Improving documentation and providing better high-level API are the focus for now.
 
 # History
 

diff --git a/fftw3.nimble b/fftw3.nimble
@@ -1,6 +1,6 @@
 # Package
 
-version       = "0.2.9"
+version       = "0.3.0"
 author        = "rcaillaud"
 description   = "Nim FFTW bindings"
 license       = "LGPL-2.1"
@@ -11,3 +11,4 @@ srcDir        = "src"
 
 requires "nim >= 1.2.0"
 requires "arraymancer >= 0.6.1"
+