Commit aa5c6456 authored by Utkarsh Ayachit's avatar Utkarsh Ayachit

Add README.md and supporting files.

parent 6d5e33fe
Contributing to ParaViewSuperbuild
==================================
Our project uses GitLab for code review and Buildbot to test proposed
patches before they are merged. Please check our [ParaViewSuperbuild Git][]
instructions for details on developing and contributing to the project.
Our [Wiki][] is used to document features, flesh out designs and host other
documentation. We have several [Mailing Lists][] to coordinate development and
to provide support.
[ParaViewSuperbuild Git]: Documentation/dev/git/README.md
[Wiki]: http://www.paraview.org/Wiki/ParaView
[Mailing Lists]: http://www.paraview.org/mailing-lists/
Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
Sandia National Laboratories, New Mexico PO Box 5800 Albuquerque, NM 87185
Kitware Inc., 28 Corporate Drive, Clifton Park, NY 12065, USA
Under the terms of Contract DE-AC04-94AL85000, there is a non-exclusive license
for use of this work by or on behalf of the U.S. Government.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
* Neither the name of Kitware nor the names of any contributors may be used to
endorse or promote products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 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.
![ParaView Superbuild](Documentation/img/paraview100.png)
Introduction
============
ParaView Superbuild is a project to build ParaView. ParaView itself can be
easily built using CMake. However, ParaView has several external dependencies,
e.g. Qt, CGNS, FFMPEG, etc. and it can be very tedious to build all those
dependencies. Also, if you want to generate redistributable binaries, you need to
take extra case building and packaging these dependencies. To make our lives
easier in supporting both these use-cases, ParaViewSuperbuild project was born.
Although primarily designed to build the official ParaView binaries,
ParaView Superbuild has since been regularly used to build ParaView packages
on various supercomputing systems.
Learning Resources
==================
* General information is available at the [ParaView Homepage][].
* Community discussion takes place on the [ParaView Mailing Lists][].
* Commercial [support][Kitware Support] and [training][Kitware Training]
are available from [Kitware][].
[ParaView Homepage]: http://www.paraview.org
[ParaView Mailing Lists]: http://www.paraview.org/mailing-lists/
[Kitware]: http://www.kitware.com/
[Kitware Support]: http://www.kitware.com/products/support.html
[Kitware Training]: http://www.kitware.com/products/protraining.php
Reporting Bugs
==============
If you have found a bug:
1. If you have a patch, please read the [CONTRIBUTING.md][] document.
2. Otherwise, please join the one of the [ParaView Mailing Lists][] and ask
about the expected and observed behaviors to determine if it is
really a bug.
3. Finally, if the issue is not resolved by the above steps, open
an entry in the [ParaView Issue Tracker][].
[ParaView Issue Tracker]: http://www.paraview.org/Bug
License
=======
Like ParaView, ParaViewSuperbuild is distributed under the OSI-approved BSD 3-clause License.
See [Copyright.txt][] for details. For additional licenses, refer to
[ParaView Licenses][].
[Copyright.txt]: Copyright.txt
[ParaView Licenses]: http://www.paraview.org/paraview-license/
Contributing
============
See [CONTRIBUTING.md][] for instructions to contribute.
[CONTRIBUTING.md]: CONTRIBUTING.md
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment