Skip to content

Commit

Permalink
Add contributing support for zsh and win (#1272)
Browse files Browse the repository at this point in the history
* fix: add support for zsh and win

* docs: add both install commands (win,lin,mac)

* fix: some typos

* docs: update win cmd examples
  • Loading branch information
Olegt0rr committed Aug 18, 2023
1 parent 5b17bd4 commit 5a14098
Showing 1 changed file with 21 additions and 14 deletions.
35 changes: 21 additions & 14 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,34 +35,33 @@ be able to install packages into that isolated environment.
Activate the environment
------------------------

Linux/ macOS:
Linux / macOS:

.. code-block:: bash
source .venv/bin/activate
Windows PoweShell
Windows cmd

.. code-block:: powershell
.\.venv\Scripts\Activate.ps1
.. code-block:: text
To check it worked, use described command, it should show the :code:`pip` location inside
the isolated environment
.\.venv\Scripts\activate
Linux, macOS:
Windows PowerShell

.. code-block::
.. code-block:: powershell
which pip
.\.venv\Scripts\activate.ps1
Windows PowerShell
To check it worked, use described command, it should show the :code:`pip` version and location
inside the isolated environment

.. code-block::
Get-Command pip
pip -V
Also make you shure you have the latest pip version in your virtual environment to avoid
Also make sure you have the latest pip version in your virtual environment to avoid
errors on next steps:

.. code-block::
Expand All @@ -73,7 +72,15 @@ errors on next steps:
Setup project
-------------

After activating the environment install `aiogram` from sources and their dependencies:
After activating the environment install `aiogram` from sources and their dependencies.

Linux / macOS:

.. code-block:: bash
pip install -e ."[dev,test,docs,fast,redis,proxy,i18n]"
Windows:

.. code-block:: bash
Expand Down

0 comments on commit 5a14098

Please sign in to comment.