From 3a766de13b818870fa60c1dbf44e0be883af8a7a Mon Sep 17 00:00:00 2001 From: Michael Hohn Date: Fri, 18 Jul 2025 14:06:52 -0700 Subject: [PATCH] Add 'Tool Setup' section --- README.org | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.org b/README.org index bd897ef..0476cd2 100644 --- a/README.org +++ b/README.org @@ -66,3 +66,20 @@ ** Additional Structure Notes - The original upstream README.md is preserved at [[./README-vscode-codeql-starter.md]] +* Tool Setup + Some scripts are used here, found in [[./bin/]]. To ensure the ones written in + Python have access to prerequites, set up a virtual environment via + #+BEGIN_SRC sh + # 1. Create the virtualenv + python3 -m venv ~/codeql-lab/venv + + # 2. Install any packages + source ~/codeql-lab/venv/bin/activate + pip install pyyaml + #+END_SRC + + For any of these scripts to work, add them to the PATH via + #+BEGIN_SRC sh + export PATH="$HOME/codeql-lab/bin:$PATH" + #+END_SRC +