aboutsummaryrefslogtreecommitdiff
path: root/doc/_sources/index.txt
diff options
context:
space:
mode:
authorMiles Macklin <[email protected]>2017-03-10 14:51:31 +1300
committerMiles Macklin <[email protected]>2017-03-10 14:51:31 +1300
commitad3d90fafe5ee79964bdfe1f1e0704c3ffcdfd5f (patch)
tree4cc6f3288363889d7342f7f8407c0251e6904819 /doc/_sources/index.txt
downloadflex-ad3d90fafe5ee79964bdfe1f1e0704c3ffcdfd5f.tar.xz
flex-ad3d90fafe5ee79964bdfe1f1e0704c3ffcdfd5f.zip
Initial 1.1.0 binary release
Diffstat (limited to 'doc/_sources/index.txt')
-rw-r--r--doc/_sources/index.txt51
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/_sources/index.txt b/doc/_sources/index.txt
new file mode 100644
index 0000000..35f0ae0
--- /dev/null
+++ b/doc/_sources/index.txt
@@ -0,0 +1,51 @@
+.. toctree::
+ :maxdepth: 1
+ :hidden:
+
+ Overview <self>
+ manual
+ releasenotes
+
+|PRODUCTNAME|
+======================================
+
+Flex is a GPU-based particle simulation library designed for real-time applications. It provides a unified interface that is capable of simulating fluids, clothing, solids, ropes, and more. See the :ref:`releasenotes` for the latest updates.
+
+Download the latest Flex release from the `product home page`_ on `NVIDIA Developer`_.
+
+Documentation
+-------------
+
+Please see the :ref:`Manual` included in this release package for more information on
+the solver API and usage.
+
+Doxygen generated API documentation is available here:
+
+* `Core API Reference <_static/api/_nv_flex_8h.html>`_
+
+* `Extensions API Reference <_static/api/_nv_flex_ext_8h.html>`_
+
+* `Device API Reference <_static/api/_nv_flex_device_8h.html>`_
+
+Supported Platforms
+-------------------
+
+* Windows 32/64 bit
+* Linux 64 bit (tested with Ubuntu 14.04 LTS)
+
+Requirements
+------------
+
+A D3D11 capable graphics card with the following driver versions:
+
+* NVIDIA: GeForce Game Ready Driver 372.90 or above
+* AMD: Radeon Software Version 16.9.1 or above
+
+To build the demo at least one of the following is required:
+
+* Microsoft Visual Studio 2013
+* Microsoft Visual Studio 2015
+* g++ 4.6.3 or higher
+* CUDA 8.0.44 toolkit
+* DirectX 11/12 SDK
+