From a5d9803fac6e512a5ea7d9f5084a6799e0d12a9d Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Tue, 24 Sep 2024 11:26:52 -0500 Subject: [PATCH] Add note on installing from stable branch (#20) (#22) (cherry picked from commit ddaaaed056c44210ebfa30888d2988176be5b866) Co-authored-by: Caleb Johnson --- README.md | 7 ++++++- docs/index.rst | 9 ++++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f26e32a..8f96fa5 100644 --- a/README.md +++ b/README.md @@ -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`` diff --git a/docs/index.rst b/docs/index.rst index 7329e8c..d54a7d0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -35,7 +35,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