Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add installation note to landing pages #21

Closed
wants to merge 1 commit into from
Closed

Add installation note to landing pages #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,12 @@ First, install some required libraries:

``sudo apt install build-essential libboost-all-dev libopenmpi-dev openmpi-bin libhdf5-openmpi-dev``

To build the binaries required for this package:
Next, install from the most recent stable branch. Users who want to install from the `main` branch should
note that the hosted documentation may not accurately reflect the state of the API in the `main` branch.

``git checkout stable/X.Y``

Build the boost and Dice binaries required for this package:

``./build.sh``

Expand Down
9 changes: 8 additions & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,14 @@ First, install some required libraries:

sudo apt install build-essential libboost-all-dev libopenmpi-dev openmpi-bin libhdf5-openmpi-dev

To build the binaries required for this package:
Next, install from the most recent stable branch. Users who want to install from the `main` branch should
note that the hosted documentation may not accurately reflect the state of the API in the `main` branch.

.. code-block:: bash

git checkout stable/X.Y

Build the boost and Dice binaries required for this package:

.. code-block:: bash

Expand Down