Docs for using a specific version

README.md

@@ -20,10 +20,12 @@ pip install git+https://github.com/cssr-tools/plopm.git
 If you are interested in a specific version (e.g., v2024.10) or in modifying the source code, then you can clone the repository and install the Python requirements in a virtual environment with the following commands:
 
 ```bash
-# Clone the repo (to get a specifc version, add the flag --branch, e.g., --branch v2024.10)
+# Clone the repo
 git clone https://github.com/cssr-tools/plopm.git
 # Get inside the folder
 cd plopm
+# For a specific version (e.g., v2024.10); otherwhise (i.e., latest version), skip this step
+git checkout v2024.10
 # Create virtual environment (for macOS, use a Python version >= 3.10)
 python3 -m venv vplopm
 # Activate virtual environment

docs/_sources/installation.rst.txt

@@ -19,10 +19,12 @@ install the Python requirements in a virtual environment with the following comm
 
 .. code-block:: console
 
-    # Clone the repo (to get a specifc version, add the flag --branch, e.g., --branch v2024.10)
+    # Clone the repo
     git clone https://github.com/cssr-tools/plopm.git
     # Get inside the folder
     cd plopm
+    # For a specific version (e.g., v2024.10); otherwhise (i.e., latest version), skip this step
+    git checkout v2024.10
     # Create virtual environment
     python3 -m venv vplopm
     # Activate virtual environment
@@ -34,6 +36,10 @@ install the Python requirements in a virtual environment with the following comm
     # For contributions/testing/linting, install the dev-requirements
     pip install -r dev-requirements.txt
 
+.. tip::
+
+    Typing **git tag -l** writes all available specific versions.
+
 .. note::
 
     For not macOS users, to install the Python opm package (this is an alternative

docs/installation.html

@@ -98,10 +98,12 @@ <h2>Python package<a class="headerlink" href="#python-package" title="Link to th
 </div>
 <p>If you are interested in a specific version (e.g., v2024.10) or in modifying the source code, then you can clone the repository and
 install the Python requirements in a virtual environment with the following commands:</p>
-<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>Clone<span class="w"> </span>the<span class="w"> </span>repo<span class="w"> </span><span class="o">(</span>to<span class="w"> </span>get<span class="w"> </span>a<span class="w"> </span>specifc<span class="w"> </span>version,<span class="w"> </span>add<span class="w"> </span>the<span class="w"> </span>flag<span class="w"> </span>--branch,<span class="w"> </span>e.g.,<span class="w"> </span>--branch<span class="w"> </span>v2024.10<span class="o">)</span>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>Clone<span class="w"> </span>the<span class="w"> </span>repo
 <span class="go">git clone https://github.com/cssr-tools/plopm.git</span>
 <span class="gp"># </span>Get<span class="w"> </span>inside<span class="w"> </span>the<span class="w"> </span>folder
 <span class="go">cd plopm</span>
+<span class="gp"># </span>For<span class="w"> </span>a<span class="w"> </span>specific<span class="w"> </span>version<span class="w"> </span><span class="o">(</span>e.g.,<span class="w"> </span>v2024.10<span class="o">)</span><span class="p">;</span><span class="w"> </span>otherwhise<span class="w"> </span><span class="o">(</span>i.e.,<span class="w"> </span>latest<span class="w"> </span>version<span class="o">)</span>,<span class="w"> </span>skip<span class="w"> </span>this<span class="w"> </span>step
+<span class="go">git checkout v2024.10</span>
 <span class="gp"># </span>Create<span class="w"> </span>virtual<span class="w"> </span>environment
 <span class="go">python3 -m venv vplopm</span>
 <span class="gp"># </span>Activate<span class="w"> </span>virtual<span class="w"> </span>environment
@@ -114,6 +116,10 @@ <h2>Python package<a class="headerlink" href="#python-package" title="Link to th
 <span class="go">pip install -r dev-requirements.txt</span>
 </pre></div>
 </div>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>Typing <strong>git tag -l</strong> writes all available specific versions.</p>
+</div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>For not macOS users, to install the Python opm package (this is an alternative