From 6de5dabe9e4319fdae4702031e51687d5da59186 Mon Sep 17 00:00:00 2001 From: mehmetyavuzz43 <147098445+mehmetyavuzz43@users.noreply.github.com> Date: Mon, 12 Jan 2026 18:26:00 +0100 Subject: [PATCH] docs: add environment checklist for first run MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added an “env checklist” to prevent the most common first-run mistakes. --- docs/env-checklist.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/env-checklist.md diff --git a/docs/env-checklist.md b/docs/env-checklist.md new file mode 100644 index 00000000..ef3aa8cd --- /dev/null +++ b/docs/env-checklist.md @@ -0,0 +1,14 @@ +# Environment Checklist + +Before running the examples: + +- Python version matches the repo requirement +- Virtualenv is activated +- `pip install -r requirements.txt` completed successfully +- Credentials/config file exists and is gitignored +- No secrets appear in your `git diff` + +If something fails: +- re-create the venv +- re-install requirements +- verify file paths used by scripts