From 124da2378f1316f46a5139fd1cf7c2f390d7e7f7 Mon Sep 17 00:00:00 2001
From: Joe Ranweiler <joranwei@microsoft.com>
Date: Tue, 5 Oct 2021 13:12:35 -0700
Subject: [PATCH] Add more setup info to `check-pr` docs (#1311)

---
 src/utils/check-pr/README.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/src/utils/check-pr/README.md b/src/utils/check-pr/README.md
index 3484ed165..26fb2f412 100644
--- a/src/utils/check-pr/README.md
+++ b/src/utils/check-pr/README.md
@@ -1,8 +1,20 @@
 # PR integration test tool
 
-Requirements:
+## Requirements
 
-* Python packages (See `requirements.txt`)
+* Python >= 3.7, and dependencies (see `requirements.txt`)
 * [az-cli](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli).
 * [azcopy](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-azcopy-v10)
 * [azure-functions-core-tools](https://docs.microsoft.com/en-us/azure/azure-functions/functions-run-local?tabs=v3%2Clinux%2Ccsharp%2Cportal%2Cbash%2Ckeda#install-the-azure-functions-core-tools)
+
+## Setup
+
+1. In GitHub, generate a personal access token (PAT) with the `public_repo` scope.
+   You may need to enable SSO for the token, depending on the org that your OneFuzz fork belongs to.
+1. Set `GITHUB_ISSUE_TOKEN` equal to the above PAT in your shell session.
+   [`direnv`](https://direnv.net/) can help here.
+1. Create and activate a virtualenv, e.g. `python -m venv venv` followed by `. ./venv/bin/activate` (e.g. on Linux).
+1. Install dependencies with `pip install -r requirements.txt`
+
+You can now invoke `check-pr.py`.
+See `./check-pr.py -h` for available commands.