Skip to content

Commit

Permalink
docs: mention example
Browse files Browse the repository at this point in the history
  • Loading branch information
leocov-dev committed Jun 22, 2024
1 parent d592f49 commit 510d5bf
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ installed under this name. In the latter case, use ``python3`` and ``pip3`` in p
and ``pip`` in these instructions.

Getting Cedar-solve
--------------
-------------------
Cedar-solve is available on PyPI (the Python Package Index). You may install it by::

pip install cedar-solve
Expand All @@ -22,6 +22,10 @@ You can test that it works by invoking the database generator command::

tetra3-gen-db --help

Example
^^^^^^^
An `example <https://github.com/smroid/cedar-solve/blob/master/examples/test_tetra3.py>`_ is available on the GitHub repository showing some ways of working with the library.

Manually download source code
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You have two options to manually download the source code.
Expand Down

0 comments on commit 510d5bf

Please sign in to comment.