diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index e573440f81c239c85fb946d2a63d3006ee49ac91..b8a43f6193bc4123be91d1a165ea1ff81f3b425b 100644 --- a/doc/source/getting_started/index.rst +++ b/doc/source/getting_started/index.rst @@ -1,12 +1,27 @@ -Getting Started -=============== +Introduction +============ teqp is a C++-based library with wrappers. The documentation is based on the Python wrapper because it can be readily integrated with the documentation tools and can be auto-generated at documentation build time. -The library can (for Python) be installed with: +Installation +============ + +Python +------ + +The library can be installed with: .. code:: pip install teqp -as the binary wheels for all major platforms are provided on pypi. \ No newline at end of file +as the binary wheels for all major platforms are provided on pypi. + +If you desire to build teqp yourself, it is recommended to pull from github and build a binary wheel: + +.. code:: + + git clone --recursive https://github.com/usnistgov/teqp + cd teqp + python setup.py bdist_wheel + pip install dist/*.whl # or replace with the appropriate binary wheel \ No newline at end of file