arrayfire · 9prady9 · Sep 4, 2017 · May 31, 2017 · May 31, 2017 · May 31, 2017
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,40 @@
+# Contributing to ArrayFire
+
+## Reporting Issues
+
+We both value and encourage the community to provide feedback about using ArrayFire and the issues they are facing.
+The more detailed the information, the easier it is for the developers to resolve the issue.
+
+Issues can span a variety of topics including:
+- Feature requests
+- Bug reports
+- Build Issues
+- Performance improvements
+- New hardware / backend support
+
+We use the github [issue tracker](https://github.com/arrayfire/arrayfire-rb/issues?state=open) to track our issues. Technical issues can also be discussed on our [user forum](https://groups.google.com/forum/#!forum/arrayfire-users).
+
+## Contributing Code
+
+If you want to contribute code, we suggest you use the one of the following methods.
+
+- [Using Github](https://github.com/arrayfire/arrayfire-rb/wiki/Contribute-code-using-github)
+- [Using Email](https://github.com/arrayfire/arrayfire-rb/wiki/Contribute-code-using-email)
+
+Key areas of code contributions include:
+- [New features](https://github.com/arrayfire/arrayfire-rb/issues?q=is%3Aopen+is%3Aissue+label%3Afeature)
+- [Bug fixes](https://github.com/arrayfire/arrayfire-rb/labels/bug)
+- [Style changes](https://github.com/arrayfire/arrayfire-rb/labels/style)
+- [Performance improvements](https://github.com/arrayfire/arrayfire-rb/labels/style)
+- [New tests](https://github.com/arrayfire/arrayfire-rb/labels/test)
+- New examples!
+
+## ArrayFire Based Projects
+
+You can also contribute to ArrayFire by helping out projects that use ArrayFire! For our part, in addition to the ArrayFire library we are also in the process of adding native bindings for numerous language. We currently support
+
+- [Java](https://github.com/arrayfire/arrayfire_java)
+- [R](https://github.com/arrayfire/arrayfire_r)
+- [Fortran](https://github.com/arrayfire/arrayfire_fortran)
+
+If you are experienced in any of these languages, you can help us improve these language bindings. If you prefer a different language that is not in the list, dive in and create a new repo!
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,6 @@
-Copyright (c) 2016, ArrayFire
+BSD 3-Clause License
+
+Copyright (c) 2016-2017, Prasun Anand and ArrayFire
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -11,7 +13,7 @@ modification, are permitted provided that the following conditions are met:
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
-* Neither the name of arrayfire-rb nor the names of its
+* Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
 
@@ -25,4 +27,3 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
diff --git a/README.md b/README.md
@@ -1,12 +1,45 @@
+<a href="http://arrayfire.com/"><img src="http://arrayfire.com/logos/arrayfire_logo_whitebkgnd.png" width="300"></a>
+
+ArrayFire is a general-purpose library that simplifies the process of developing
+software that targets parallel and massively-parallel architectures including
+CPUs, GPUs, and other hardware acceleration devices.
+
 # Ruby wrapper for ArrayFire
 
 [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/arrayfire/arrayfire-ruby)
 
 Ruby bindings are a work in progress and are not production ready yet.
 
-## Build from source
+## Installation
+
 ```sh
 git clone https://github.com/arrayfire/arrayfire-rb
+cd arrayfire/
+gem install bundler
 bundle install
 rake compile
 ```
+
+Run the tests using
+
+```sh
+rake test
+```
+
+If you want to try out the code without installing:
+
+```sh
+rake pry
+```
+
+To install:
+
+```sh
+rake install
+```
+
+# LICENSE
+
+This software is distributed under the [BSD 3-Clause License](LICENSE).
+
+Copyright © 2017, Prasun Anand and ArrayFire
diff --git a/Rakefile b/Rakefile
@@ -1,5 +1,8 @@
+require "bundler/gem_tasks"
 require 'rake'
 require 'rake/extensiontask'
+require "rake/testtask"
+require "rdoc/task"
 
 Rake::ExtensionTask.new do |ext|
   ext.name = 'arrayfire'
@@ -21,3 +24,16 @@ end
 def run(*cmd)
   sh(cmd.join(' '))
 end
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include(%w{README.md LICENSE CONTRIBUTING.md lib ext})
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test
diff --git a/arrayfire.gemspec b/arrayfire.gemspec
@@ -1,20 +1,37 @@
+# coding: utf-8
+$:.unshift File.expand_path("../lib", __FILE__)
+
+require 'arrayfire/version.rb'
+
+ArrayFire::DESCRIPTION = <<MSG
+ArrayFire is a general-purpose library that simplifies the process of developing
+software that targets parallel and massively-parallel architectures including
+CPUs, GPUs, and other hardware acceleration devices.
+MSG
+
 Gem::Specification.new do |gem|
-  gem.name        = 'ArrayFire'
-  gem.version     = '0.0.0'
+  gem.name        = 'arrayfire'
+  gem.version     = ArrayFire::VERSION
   gem.date        = '2016-09-29'
   gem.summary     = 'Ruby wrapper for ArrayFire.'
-  gem.description = 'Ruby wrapper for ArrayFire.'
+  gem.description = ArrayFire::DESCRIPTION
   gem.authors     = ['Prasun Anand']
   gem.email       = '[email protected]'
   gem.files       = ['lib/arrayfire.rb']
   gem.homepage    = 'http://rubygems.org/gems/arrayfire'
   gem.license     = 'BSD-3-Clause'
-  gem.add_development_dependency 'rubocop'
+  gem.extensions  = ['ext/mri/extconf.rb']
+  gem.files       = `git ls-files -- ext/mri`.split("\n")
+  gem.files      += `git ls-files -- lib`.split("\n")
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency 'rubocop', '~> 0'
   gem.add_development_dependency 'bundler', '~>1.6'
-  gem.add_development_dependency 'json'
+  gem.add_development_dependency 'json', '~> 0'
   gem.add_development_dependency 'pry', '~>0.10'
   gem.add_development_dependency 'rake', '~>10.3'
   gem.add_development_dependency 'rake-compiler', '~>0.8'
   gem.add_development_dependency 'rdoc', '~>4.0', '>=4.0.1'
-  gem.add_development_dependency 'rspec', '~>2.14'
-end
+  gem.add_development_dependency "minitest", "~> 5.0"
+
+  gem.add_development_dependency 'nmatrix', '~> 0.2.1'
+end
diff --git a/examples/benchmarks/blas.rb b/examples/benchmarks/blas.rb
diff --git a/examples/benchmarks/cg.rb b/examples/benchmarks/cg.rb
diff --git a/examples/benchmarks/fft.rb b/examples/benchmarks/fft.rb
diff --git a/examples/benchmarks/pi.rb b/examples/benchmarks/pi.rb
diff --git a/examples/computer_vision/fast.rb b/examples/computer_vision/fast.rb
diff --git a/examples/computer_vision/harris.rb b/examples/computer_vision/harris.rb
diff --git a/examples/computer_vision/matching.rb b/examples/computer_vision/matching.rb
diff --git a/examples/computer_vision/susan.rb b/examples/computer_vision/susan.rb
diff --git a/examples/financial/black_scholes_options.rb b/examples/financial/black_scholes_options.rb
diff --git a/examples/financial/heston_model.rb b/examples/financial/heston_model.rb
diff --git a/examples/financial/monte_carlo_options.rb b/examples/financial/monte_carlo_options.rb
diff --git a/examples/getting_started/convolve.rb b/examples/getting_started/convolve.rb
diff --git a/examples/getting_started/integer.rb b/examples/getting_started/integer.rb
diff --git a/examples/getting_started/rainfall.rb b/examples/getting_started/rainfall.rb
diff --git a/examples/getting_started/vectorize.rb b/examples/getting_started/vectorize.rb
diff --git a/examples/helloworld/helloworld.rb b/examples/helloworld/helloworld.rb
diff --git a/examples/image_processing/adaptive_thresholding.rb b/examples/image_processing/adaptive_thresholding.rb
diff --git a/examples/image_processing/binary_thresholding.rb b/examples/image_processing/binary_thresholding.rb
diff --git a/examples/image_processing/brain_segmentation.rb b/examples/image_processing/brain_segmentation.rb
diff --git a/examples/image_processing/edge.rb b/examples/image_processing/edge.rb
diff --git a/examples/image_processing/filters.rb b/examples/image_processing/filters.rb
diff --git a/examples/image_processing/image_demo.rb b/examples/image_processing/image_demo.rb
diff --git a/examples/image_processing/image_editing.rb b/examples/image_processing/image_editing.rb
diff --git a/examples/image_processing/morphing.rb b/examples/image_processing/morphing.rb
diff --git a/examples/image_processing/optical_flow.rb b/examples/image_processing/optical_flow.rb
diff --git a/examples/image_processing/pyramids.rb b/examples/image_processing/pyramids.rb
diff --git a/examples/lin_algebra/cholesky.rb b/examples/lin_algebra/cholesky.rb
diff --git a/examples/lin_algebra/lu.rb b/examples/lin_algebra/lu.rb
diff --git a/examples/lin_algebra/qr.rb b/examples/lin_algebra/qr.rb
diff --git a/examples/lin_algebra/svd.rb b/examples/lin_algebra/svd.rb
diff --git a/examples/machine_learning/bagging.rb b/examples/machine_learning/bagging.rb
diff --git a/examples/machine_learning/deep_belief_net.rb b/examples/machine_learning/deep_belief_net.rb
diff --git a/examples/machine_learning/geneticalgorithm.rb b/examples/machine_learning/geneticalgorithm.rb
diff --git a/examples/machine_learning/kmeans.rb b/examples/machine_learning/kmeans.rb
diff --git a/examples/machine_learning/knn.rb b/examples/machine_learning/knn.rb
diff --git a/examples/machine_learning/logistic_regression.rb b/examples/machine_learning/logistic_regression.rb
diff --git a/examples/machine_learning/naive_bayes.rb b/examples/machine_learning/naive_bayes.rb
diff --git a/examples/machine_learning/neural_network.rb b/examples/machine_learning/neural_network.rb
diff --git a/examples/machine_learning/perceptron.rb b/examples/machine_learning/perceptron.rb
diff --git a/examples/machine_learning/rbm.rb b/examples/machine_learning/rbm.rb
diff --git a/examples/machine_learning/softmax_regression.rb b/examples/machine_learning/softmax_regression.rb
diff --git a/examples/pde/swe.rb b/examples/pde/swe.rb
diff --git a/examples/unified/basic.rb b/examples/unified/basic.rb