From 7e25798e7fad15142bfedb4ff864f73428d14f7f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrique=20F=2E=20Sim=C3=B5es?=
 <33237318+henriquesimoes@users.noreply.github.com>
Date: Tue, 24 Sep 2024 12:49:14 -0300
Subject: [PATCH] readme: deduplicate requirement version specification (#452)

* readme: use code block for shell command

ReStructured Text has a specific syntax to specify code blocks [1]. Use
that so renderers can display its content nicely.

[1] https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#literal-blocks

* readme: deduplicate requirement version specification

Specifying the dependency versions in the README file creates an extra
maintenance burden not worth the effort. In fact, it has been left
outdated more than once leading to misinformation [1, 2, 3]. Instead,
provide the rough information in the documentation and point users to
the source of truth for details.

Python 3 is still listed explicitly since it won't be bumped every now
and then, and provides a useful compatibility information for users.
Unfortunately, PyVISA cannot be dealt with in a similar vein.

[1] dd8e9041bb9d ("switch to a PEP517 install")
[2] 8a0753b4e23d ("bump Python requirement to 3.8 and PyVISA requirement to 1.13")
[3] 29d3048d23e2 ("Drop support for Python 3.8 and 3.9 and add support for Python 3.13")
---
 README.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/README.rst b/README.rst
index aca7520a..6e64b638 100644
--- a/README.rst
+++ b/README.rst
@@ -61,8 +61,8 @@ controlling:
 Requirements
 ------------
 
-- Python (tested with 3.6+)
-- PyVISA 1.11+
+- Python 3
+- PyVISA
 
 Optionally:
 
@@ -74,11 +74,13 @@ Optionally:
 - zeroconf (for HiSLIP and VICP devices discovery)
 - pyvicp (to enable the Teledyne LeCroy proprietary VICP protocol)
 
+Please refer to `pyproject.toml <./pyproject.toml>`_ for the specific version
+requirements.
 
 Installation
 --------------
 
-Using pip:
+Using pip::
 
     $ pip install pyvisa-py