Fill in the README and documentation

README.md

@@ -1,3 +1,13 @@
 # FFTW.jl
 
-TODO
+This package provides Julia bindings to the [FFTW](http:https://www.fftw.org/) library for
+fast Fourier transforms, as well as functionality useful for signal processing.
+These functions were formerly a part of Base Julia.
+
+[![Travis](https://travis-ci.org/JuliaMath/FFTW.jl.svg?branch=master)](https://travis-ci.org/JuliaMath/FFTW.jl)
+[![AppVeyor](https://ci.appveyor.com/api/projects/status/hofbdbyt287qn49s/branch/master?svg=true)](https://ci.appveyor.com/project/ararslan/fftw-jl/branch/master)
+[![Coveralls](https://coveralls.io/repos/github/JuliaMath/FFTW.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaMath/FFTW.jl?branch=master)
+
+Documentation:
+[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaMath.github.io/FFTW.jl/stable)
+[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://JuliaMath.github.io/FFTW.jl/latest)

REQUIRE

@@ -1,4 +1,4 @@
 julia 0.6-
-BinDeps
+BinDeps 0.6.0
 @osx Homebrew
 @windows WinRPM

deps/build.jl

@@ -20,7 +20,7 @@ provides(AptGet, "libfftw3", [libfftw, libfftwf], os=:Linux)
 provides(Pacman, "fftw", [libfftw, libfftwf], os=:Linux)
 provides(Zypper, "libfftw3", [libfftw, libfftwf], os=:Linux)
 provides(Yum, "fftw", [libfftw, libfftwf], os=:Linux)
-# provides(BSDPkg, "fftw3", [libfftw, libfftwf], os=:FreeBSD)
+provides(BSDPkg, "fftw3", [libfftw, libfftwf], os=:FreeBSD)
 
 if is_windows()
  using WinRPM

docs/make.jl

@@ -7,6 +7,8 @@ makedocs(
  sitename = "FFTW.jl",
  pages = Any[
  "Home" => "index.md",
+ "Fourier Transforms" => "fft.md",
+ "Signal Processing" => "dsp.md",
  ],
 )
 

docs/src/dsp.md

@@ -0,0 +1,12 @@
+# Signal Processing
+
+It is expected that these functions will be moved to a different package.
+
+```@docs
+FFTW.filt
+FFTW.filt!
+FFTW.deconv
+FFTW.conv
+FFTW.conv2
+FFTW.xcorr
+```

docs/src/fft.md

@@ -0,0 +1,43 @@
+# Fourier Transforms
+
+```@docs
+FFTW.fft
+FFTW.fft!
+FFTW.ifft
+FFTW.ifft!
+FFTW.bfft
+FFTW.bfft!
+FFTW.plan_fft
+FFTW.plan_ifft
+FFTW.plan_bfft
+FFTW.plan_fft!
+FFTW.plan_ifft!
+FFTW.plan_bfft!
+FFTW.rfft
+FFTW.irfft
+FFTW.brfft
+FFTW.plan_rfft
+FFTW.plan_brfft
+FFTW.plan_irfft
+FFTW.dct
+FFTW.dct!
+FFTW.idct
+FFTW.idct!
+FFTW.plan_dct
+FFTW.plan_dct!
+FFTW.plan_idct
+FFTW.plan_idct!
+FFTW.fftshift(::Any)
+FFTW.fftshift(::Any, ::Any)
+FFTW.ifftshift
+```
+
+The following functions are not exported from the package and thus must be qualified
+with the `FFTW.` prefix on use.
+
+```@docs
+FFTW.r2r
+FFTW.r2r!
+FFTW.plan_r2r
+FFTW.plan_r2r!
+```

docs/src/index.md

@@ -0,0 +1,28 @@
+# FFTW.jl
+
+This package provides bindings to the [FFTW](http:https://www.fftw.org/) library for
+fast Fourier transforms.
+
+## Installation
+
+The package is available for Julia versions 0.6 and up.
+To install it, run
+
+```julia
+Pkg.add("FFTW")
+```
+
+from the Julia REPL.
+
+## Note
+
+These functions were formerly part of Base Julia.
+Should any name conflicts occur on Julia versions which include these functions,
+try adding
+
+```julia
+importall FFTW
+```
+
+to the top of your file.
+If the problem persists, please open an issue on this package's repository.