Merge pull request #25 from cadenmyers13/getting-started

docs: update getting started page

Author: sbillinge

doc/source/getting-started.rst

@@ -8,4 +8,31 @@
 Getting started
 ================
 
-Coming soon...
+.. image:: ./img/pdfprimer.png
+    :alt: codecov-in-pr-comment
+    :width: 150px
+    :align: right
+
+For detailed instructions and in-depth examples of modeling with ``diffpy.cmi``, we highly recommend the book,
+
+*Atomic Pair Distribution Function Analysis: A Primer* by Simon J. L. Billinge and Kirsten M. Ø. Jensen (Oxford University Press, 2023).
+
+To purchase this book, please visit `this link <https://www.amazon.com/Atomic-Pair-Distribution-Function-Analysis/dp/0198885806>`_.
+
+Installation
+------------
+
+To install ``diffpy.cmi``, create a new conda environment or activate an existing environment and install the package from the conda-forge channel.
+
+.. code-block:: console
+
+    conda create -n diffpy.cmi-env
+    conda install -c conda-forge diffpy.cmi
+    conda activate diffpy.cmi-env
+
+
+Data and Examples
+-----------------
+
+Worked examples and experimental data from the book are freely available at our
+`GitHub repository <https://github.com/Billingegroup/pdfttp_data>`_.

doc/source/img/pdfprimer.png

@@ -43,6 +43,18 @@ Acknowledgements
 
 ``diffpy.cmi`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.
 
+========
+Citation
+========
+
+If you use ``diffpy.cmi`` in a scientific publication, we would like you to cite this package as
+
+    Juhás, P.; Farrow, C. L.; Yang, X.; Knox, K. R.; Billinge, S. J. L.
+    Complex Modeling: A Strategy and Software Program for Combining Multiple Information Sources to Solve Ill Posed Structure and Nanostructure Inverse Problems.
+    *Acta Crystallogr A Found Adv* **2015**, *71* (6), 562–568.
+    `https://doi.org/10.1107/S2053273315014473 <https://doi.org/10.1107/S2053273315014473>`_
+
+
 =================
 Table of contents
 =================

doc/source/index.rst

@@ -0,0 +1,23 @@
+**Added:**
+
+* Add getting started page to docs with link to primer book.
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>