From 5a140988039ff08e06a3d267e1df858074f1f689 Mon Sep 17 00:00:00 2001 From: Oleg A Date: Fri, 18 Aug 2023 12:06:13 +0300 Subject: [PATCH] Add contributing support for zsh and win (#1272) * fix: add support for zsh and win * docs: add both install commands (win,lin,mac) * fix: some typos * docs: update win cmd examples --- docs/contributing.rst | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index a0a80181..a4a3b8e0 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -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 +.. code-block:: text - .\.venv\Scripts\Activate.ps1 - -To check it worked, use described command, it should show the :code:`pip` location inside -the isolated environment - -Linux, macOS: - -.. code-block:: - - which pip + .\.venv\Scripts\activate Windows PowerShell +.. code-block:: powershell + + .\.venv\Scripts\activate.ps1 + +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:: @@ -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