Add note on installing from stable branch (#20) (#22)

(cherry picked from commit ddaaaed) Co-authored-by: Caleb Johnson <[email protected]>
Qiskit · Sep 24, 2024 · a5d9803 · a5d9803
1 parent 4d12e71
commit a5d9803
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git 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
@@ -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