From cccb47f7d60fe0948cad7d0fae18420b7d649ddb Mon Sep 17 00:00:00 2001 From: seylu <98249191+seyLu@users.noreply.github.com> Date: Mon, 28 Aug 2023 06:30:47 +0800 Subject: [PATCH] docs: add step to install dependencies --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6e90f31..4a5f20a 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,31 @@ python==3.11 git clone git@github.com:seyLu/setup-issue-label-cli.git ``` -#### 2. Create `.env` and supply github credentials +#### 2. Install dependencies + +##### Create a new virtual environment + +```bash +python -m venv .venv +``` + +##### Activate the virtual environment + +```bash +# Linux/Mac +. .venv/bin/activate + +# Windows +. .venv/Scripts/activate +``` + +##### Install dependencies from requirements.txt + +```bash +pip install -r requirements.txt +``` + +#### 3. Create `.env` and supply github credentials ```bash cp .env.example .env @@ -44,7 +68,7 @@ GITHUB_REPO_OWNER= GITHUB_REPO_NAME= ``` -#### 3. Run the CLI tool +#### 4. Run the CLI tool ```py python scripts/setup_issue_label.py @@ -52,7 +76,7 @@ python scripts/setup_issue_label.py
-### Overriding Label Config Defaults +### Adding Custom Issue Labels > Currently only supports YAML config