From 2f173fccdd8a37f5588e836626c817e5379ddae4 Mon Sep 17 00:00:00 2001
From: Ian Bell <ian.bell@nist.gov>
Date: Wed, 6 Jul 2022 20:07:43 -0400
Subject: [PATCH] Better getting started
---
doc/source/getting_started/index.rst | 23 +++++++++++++++++++----
1 file changed, 19 insertions(+), 4 deletions(-)
diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst
index e573440..b8a43f6 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
--
GitLab