Skip to content

Commit b8aaf29

Browse files
committed
update README
1 parent 870ec35 commit b8aaf29

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.rst

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
**A GUI for managing multiple Python virtual environments**
44

5-
.. image:: https://img.shields.io/badge/pypi-v0.3.3-blue?logo=pypi&logoColor=FFE873
6-
:target: https://pypi.org/project/venvipy/0.3.3/#description
5+
.. image:: https://img.shields.io/badge/pypi-v0.3.4-blue?logo=pypi&logoColor=FFE873
6+
:target: https://pypi.org/project/venvipy/0.3.4/#description
77

88
.. image:: https://img.shields.io/badge/python-3.6+-blue?logo=python&logoColor=FFE873
99
:target: https://www.python.org/downloads
@@ -23,8 +23,9 @@
2323
.. image:: https://img.shields.io/badge/license-GPL%203.0-darkviolet
2424
:target: https://github.com/sinusphi/venvipy/blob/main/LICENSE
2525

26-
.. image:: https://img.shields.io/travis/sinusphi/venvipy/main?label=Travis%20CI&logo=travis
27-
:target: https://travis-ci.org/sinusphi/venvipy
26+
..
27+
.. image:: https://img.shields.io/travis/sinusphi/venvipy/main?label=Travis%20CI&logo=travis
28+
:target: https://travis-ci.org/sinusphi/venvipy
2829
2930
|
3031
@@ -75,7 +76,7 @@ Key Features
7576
* Search and install packages from `PyPI <https://pypi.org/>`__
7677
* Install from requirements files
7778
* Install from local stored project directories
78-
* Install from VCS project urls *(currently git only)*
79+
* Install from a VCS project url *(currently git only)*
7980
* Install from local or remote source archives
8081

8182
|
@@ -95,8 +96,15 @@ you will have to make sure that the packages ``python3-venv`` and
9596
``python3-pip`` are installed, because in this case the operating system's
9697
venv and pip will be used to perform commands.
9798

98-
Also installing packages into your operating system's Python is discouraged.
99-
It's a better idea to create a virtual environment and run *VenviPy* inside:
99+
Also installing packages directly into your operating system's Python is
100+
discouraged. If you want to do it anyway, you can do it like this:
101+
102+
.. code-block:: bash
103+
104+
$ python3.x -m pip install venvipy
105+
106+
The better way however is to create a virtual environment and install
107+
*VenviPy* into it:
100108

101109
.. code-block:: bash
102110
@@ -143,14 +151,14 @@ Clone the repository (use the ``--depth`` option):
143151

144152
.. code-block:: bash
145153
146-
$ (your_venv) git clone --depth 1 [email protected]:sinusphi/venvipy.git
154+
$ (your_venv) git clone --depth 50 [email protected]:sinusphi/venvipy.git
147155
148-
Cd into the repo folder and install the dependencies (if you're using Python 3.6 you will
149-
also need to install the `dataclasses` package):
156+
Cd into the repo folder and install the dependencies. On Python 3.6 you will also
157+
need to install the ``dataclasses`` package:
150158

151159
.. code-block:: bash
152160
153-
$ (your_venv) pip install PyQt5==5.15.4 PyQt5-sip
161+
$ (your_venv) pip install PyQt5==5.15.4 PyQt5-sip requests beautifoulsoup4
154162
155163
or from `requirements.txt <https://github.com/sinusphi/venvipy/blob/main/requirements.txt>`__:
156164

0 commit comments

Comments
 (0)