Merge pull request #175 from netromdk/issue-158

Improved usage section of Readme
netromdk · Apr 8, 2023 · 68458af · 68458af
2 parents f8235dc + 7d3ba05
commit 68458af
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -71,11 +71,14 @@ Table of Contents
 Usage
 =====
 
-It is fairly straightforward to use Vermin::
+It is fairly straightforward to use Vermin.
 
-  ./vermin.py /path/to/your/project
+Running it from the repository either directly or through specific interpreter::
 
-Or via `PyPi <https://pypi.python.org/pypi/vermin/>`__::
+  % ./vermin.py /path/to/your/project        # (1) executing via `/usr/bin/env python`
+  % python3 vermin.py /path/to/your/project  # (2) specifically `python3`
+
+Or if installed via `PyPi <https://pypi.python.org/pypi/vermin/>`__::
 
   % pip install vermin
   % vermin /path/to/your/project