some updates to the documentation

Florian-Katerndahl · Oct 13, 2024 · 9bbecea · 9bbecea
1 parent 3dccfe2
commit 9bbecea
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 4 deletions.
diff --git a/docs/chapters/setup.rst b/docs/chapters/setup.rst
@@ -12,12 +12,11 @@ Installation
 
     pip install callusgs
 
-Alternatively, clone this repository and run ``poetry install`` to create a new virtual environment from which the package and programs are accessible.
+Alternatively, if you're only interested in the CLI functionality of this tool the best choice is probably to use `pipx <https://github.com/pypa/pipx>`_ for installation.
 
-Installing Extras
-^^^^^^^^^^^^^^^^^
+.. code-block:: bash
 
-*To be filled*
+   pipx install callusgs
 
 EROS/USGS Account
 -----------------

diff --git a/docs/index.rst b/docs/index.rst
@@ -105,6 +105,29 @@ Alternatively, if you're only interested in the CLI functionality of this tool t
 
    pipx install callusgs
 
+Citation
+--------
+
+If you're using ``callusgs`` in your work, please cite it according to the `CITATION file <https://github.com/Florian-Katerndahl/callusgs/blob/main/CITATION.cff>`_.
+A ready-to-use bibtex entry is listed below.
+
+.. include:: ../CITATION.cff
+   :code: json
+   :literal:
+   :number-lines: 1
+
+.. code-block:: bibtex
+
+   @software{Katerndahl2024,
+      author = {Katerndahl, Florian},
+      doi = {10.5281/zenodo.13351646},
+      version = {v0.1.3},
+      month = {8},
+      title = {callusgs},
+      url = {https://github.com/Florian-Katerndahl/callusgs},
+      year = {2024}
+   }
+
 .. Indices and tables
 .. ==================