diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 000000000..17659f73b --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,29 @@ +Contributing to NengoDL +======================= + +Issues and pull requests are always welcome! We appreciate help from the +community to make NengoDL better. + +Filing issues +------------- + +If you find a bug in NengoDL, or think that a certain feature is missing, +please consider `filing an issue `_. +Please search the currently open issues first to see if your bug or feature +request already exists. If so, feel free to add a comment to the issue +so that we know that multiple people are affected. + +Making pull requests +-------------------- + +If you want to fix a bug or add a feature to NengoDL, we welcome pull requests. +We try to maintain 100% test coverage, so any new features should also include +unit tests to cover that change. If you fix a bug it's also a good idea to +add a unit test, so that the bug doesn't get un-fixed in the future! + +Contributor agreement +--------------------- + +We require that all contributions be covered under our contributor assignment +agreement. Please see `the agreement `_ +for instructions on how to sign. diff --git a/LICENSE.rst b/LICENSE.rst index 92ac53f85..e36dc487a 100644 --- a/LICENSE.rst +++ b/LICENSE.rst @@ -1,14 +1,26 @@ NengoDL license =============== +Copyright (c) 2015 Applied Brain Research Inc. + NengoDL is made available under a proprietary license that permits -using, copying, sharing, and making derivative works -from NengoDL and its source code for any non-commercial purpose. +using, copying, sharing, and making derivative works from NengoDL and its +source code for any non-commercial purpose, as long as the above copyright +notice and this permission notice are included in all copies or substantial +portions of the software. If you would like to use NengoDL commercially, licenses can be purchased from Applied Brain Research, Inc. Please contact info@appliedbrainresearch.com for more information. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + Licensed code ------------- diff --git a/docs/conf.py b/docs/conf.py index 33de8d2e3..50596dc3c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,7 +17,6 @@ 'sphinx.ext.githubpages', 'sphinx.ext.intersphinx', 'sphinx.ext.mathjax', - 'sphinx.ext.todo', 'sphinx.ext.viewcode', 'numpydoc', 'nengo.utils.docutils', @@ -36,8 +35,6 @@ 'nengo': ('https://www.nengo.ai/nengo/', None), } -# -- sphinx.ext.todo -todo_include_todos = True # -- numpydoc config numpydoc_show_class_members = False @@ -61,10 +58,6 @@ master_doc = 'index' suppress_warnings = ['image.nonlocal_uri'] -# Need to include https Mathjax path for sphinx < v1.3 -mathjax_path = ("https://cdn.mathjax.org/mathjax/latest/MathJax.js" - "?config=TeX-AMS-MML_HTMLorMML") - project = u'NengoDL' authors = u'Applied Brain Research' copyright = nengo_dl.__copyright__ @@ -81,7 +74,6 @@ html_context = { 'css_files': [os.path.join('_static', 'custom.css')], } -html_use_smartypants = True htmlhelp_basename = 'Nengodoc' html_last_updated_fmt = '' # Suppress 'Last updated on:' timestamp html_show_sphinx = False diff --git a/docs/project.rst b/docs/project.rst index 4770df7c5..7d58435a4 100644 --- a/docs/project.rst +++ b/docs/project.rst @@ -4,4 +4,6 @@ Project information .. include:: ../CHANGES.rst +.. include:: ../CONTRIBUTING.rst + .. include:: ../LICENSE.rst \ No newline at end of file