Merge pull request #110 from kknox/releaseReadiness

Release readiness. Besides of my question everything is fine.

CONTRIBUTING.md

@@ -13,10 +13,8 @@ Firstly, in order to contribute code to this project, a contributor must have a
 At this point, the repository maintainers will be notified by GitHub that a 'pull request' exists pending against their repository.  A code review should be completed within a few days, depending on the scope of submitted code, and the code will either be accepted, rejected or commented on for feedback.
 
 ## Code submission guidelines
-We want to ensure that the project code base maintains a level of quality over time, such that future contributors find it as easy to jump into the code as hopefully it is today.  As such, pull requests should
-* follow the [code style guidelines]( ) of the project as posted to the project wiki.  Unfortunately, there was no unifying code guidelines defined between the BLAS & FFT projects, but code submissions should not mix styles within an individual file.  We have since defined and posted a code style guideline for the projects and we expect the code to slowly transition to the new
-guidelines over time
-    *  separate check-ins that modify a files style from the ones that add/change/delete code.
+Points to remember when generating pull-requests against clSPARSE
+* clSPARSE is a project licensed under the [Apache License, Version 2.0]( http://www.apache.org/licenses/LICENSE-2.0 ).  If you are not already familiar, please review the license before issuing a pull request.  We intend this project to be open to external contributors, and encourage developers to contribute code back that they believe will provide value to the overall community.  We interpret an explicit 'pull request' to this repository as an implicit acknowledgement from the contributor that they wish to share code under the terms of the Apache license v2.0.
 * target the **develop** branch
 * ensure that the [code properly builds]( https://github.com/kknox/clSPARSE/wiki/Build )
   * Proper cloud based build services should verify the code builds in a PR

LICENSE

@@ -0,0 +1,176 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

NOTICE

@@ -0,0 +1,9 @@
+clSPARSE
+    Copyright 2015 Advanced Micro Devices, Inc.
+    Copyright 2015 Vratis, Ltd.
+
+    This product includes software developed at
+    Advanced Micro Devices, Inc. (http://www.amd.com).
+
+    This product includes software developed at
+    Vratis, Ltd. (http://www.vratis.com).

README.md

@@ -1,30 +1,12 @@
-## Project badges
-**coming soon**
-
-Pre-built binaries **not yet** available on our releases page **coming soon**
+Pre-built binaries are available on our [releases page](releases)
 
 # clSPARSE
-an OpenCL© library implementing Sparse linear algebra.  This project started
+an OpenCL© library implementing sparse linear algebra.  This project started
 as a collaboration between [AMD Inc.](http://www.amd.com/) and
-[Vratis Ltd.](http://www.vratis.com/).  In opening the source to the public, we
-invite all interested parties to [contribute](CONTRIBUTING.md) to the source.
+[Vratis Ltd.](http://www.vratis.com/).
 
 ## Introduction to clSPARSE
-The library source compiles cross-platform on the back of an advanced cmake build
-system allowing users to build the library, benchmarks, tests and takes care of
-dependencies for them.  True in spirit with
-the other clMath libraries, clSPARSE exports a “C” interface to allow
-projects to build wrappers around clSPARSE in any language they need.   With
-respect to the API, a great deal of thought and effort went into designing the
-API’s to make them less ‘cluttered’ compared to the older clMath libraries.  
-OpenCL state is not explicitly passed through the API, which enables the library
-to be forward compatible when users are ready to switch from OpenCL 1.2 to OpenCL
-2.0.  Lastly, the API’s are designed such that users are in control of where
-input and output buffers live, and they maintain absolute control of when data
-transfers to/from device memory need to happen, so that there are no performance
-surprises.
-
-At release, clSPARSE provides these fundamental sparse operations for OpenCL:
+At this time, clSPARSE provides these fundamental sparse operations for OpenCL:
 -  Sparse Matrix - dense Vector multiply (SpM-dV)
 -  Sparse Matrix - dense Matrix multiply (SpM-dM)
 -  Iterative conjugate gradient solver (CG)
@@ -33,11 +15,16 @@ At release, clSPARSE provides these fundamental sparse operations for OpenCL:
 -  COO to CSR conversions (& converse)
 -  Functions to read matrix market files in COO or CSR format
 
-### clSPARSE build information
-A [Build primer](https://github.com/kknox/clSPARSE/wiki/Build) is available
+True in spirit with the other clMath libraries, clSPARSE exports a “C” interface to allow
+projects to build wrappers around clSPARSE in any language they need.  A great deal
+of thought and effort went into designing the API’s to make them less ‘cluttered’
+compared to the older clMath libraries.  OpenCL state is not explicitly passed
+through the API, which enables the library to be forward compatible when users are
+ready to switch from OpenCL 1.2 to OpenCL 2.0 _(OpenCL 2.0 support not completely finished)_
 
-### clSPARSE library user documentation
-**API documentation** not yet available
+The API’s are designed such that users are in control of where input and output
+buffers live, and they maintain control of when data transfers to/from device
+memory happen, so that there are no performance surprises.
 
 ### Google Groups
 Two mailing lists have been created for the clMath projects:
@@ -48,51 +35,64 @@ Two mailing lists have been created for the clMath projects:
 -   [email protected] - group whose focus is for
     developers interested in contributing to the library code itself
 
-### Contributing code
-Please refer to and read the [Contributing](CONTRIBUTING.md) document for guidelines on
-how to contribute code to this open source project. Code in the
-/master branch is considered to be stable and new library releases are made
-when commits are merged into /master.  Active development and pull-requests should
-be made to the /develop branch.
+### API semantic versioning
+Good software is typically the result of the loop of feedback and iteration;
+software interfaces no less so.  clSPARSE follows the
+[semantic versioning](http://semver.org/) guidelines, and while the major version
+number remains '0', the public API should not be considered stable.  We release
+clSPARSE as beta software (0.y.z) early to the community to elicit feedback and
+comment.  This comes with the expectation that with feedback, we may incorporate
+breaking changes to the API that might require early users to recompile, or rewrite
+portions of their code as we iterate on the design.
 
 ## Samples
 clSPARSE contains a directory of simple [OpenCL samples](./samples) that demonstrate the use
 of the API in both C and C++.  The [superbuild](http://www.kitware.com/media/html/BuildingExternalProjectsWithCMake2.8.html)
 script for clSPARSE also builds the samples as an external project, to demonstrate
 how an application would find and link to clSPARSE with cmake.
 
-## Build dependencies
+### clSPARSE library documentation
+**API documentation** is not yet available, but the samples above give an excellent
+starting point to basic library operations.
+
+### Contributing code
+Please refer to and read the [Contributing](CONTRIBUTING.md) document for guidelines on
+how to contribute code to this open source project. Code in the
+/master branch is considered to be stable and new library releases are made
+when commits are merged into /master.  Active development and pull-requests should
+be made to the **/develop** branch.
+
+## Build
 clSPARSE is primarily written with C++ using C++11 core features.  It does export
 a 'C' interface for compatibility with other languages.
 
+### How to build clSPARSE for your platform
+A [Build primer](https://github.com/kknox/clSPARSE/wiki/Build) is available on
+the wiki, which describes how to use cmake to generate platforms specific build
+files
+
 ### Compiling for Windows
 -  Windows® 7/8
 -  Visual Studio 2013 and above
 -  CMake 2.8.12 (download from [Kitware](http://www.cmake.org/download/))
   -  Solution (.sln) or
   -  Nmake makefiles
--   An OpenCL SDK, such as [APP SDK 3.0](http://developer.amd.com/tools-and-sdks/opencl-zone/amd-accelerated-parallel-processing-app-sdk/)
+-  An OpenCL SDK, such as [APP SDK 3.0](http://developer.amd.com/tools-and-sdks/opencl-zone/amd-accelerated-parallel-processing-app-sdk/)
 
 ### Compiling for Linux
 -  GCC 4.8 and above
 -  CMake 2.8.12 (install with distro package manager )
    -  Unix makefiles or
    -  KDevelop or
    -  QT Creator
-   -  An OpenCL SDK, such as [APP SDK 3.0](http://developer.amd.com/tools-and-sdks/opencl-zone/amd-accelerated-parallel-processing-app-sdk/)
+-  An OpenCL SDK, such as [APP SDK 3.0](http://developer.amd.com/tools-and-sdks/opencl-zone/amd-accelerated-parallel-processing-app-sdk/)
 
 ### Compiling for Mac OSX
 -   CMake 2.8.12 (install via [brew](http://brew.sh/))
    -  Unix makefiles or
    -  XCode
 - An OpenCL SDK (installed via `xcode-select --install`)
 
-### Test infrastructure dependencies
+### Bench & Test infrastructure dependencies
 -   Googletest v1.7
 -   Boost v1.58
-
-### Benchmark infrastructure dependencies
--   Boost v1.58
-
-  [API documentation]: http://clmathlibraries.github.io/clSPARSE/
-  [binary_release]: https://github.com/clMathLibraries/clSPARSE/releases