From 5752b8e2cd2f8fe21df35f60d55aa7c1bb7fc5eb Mon Sep 17 00:00:00 2001 From: TheSomsie Date: Mon, 15 Dec 2025 21:21:03 +0100 Subject: [PATCH] docs: add quickstart notes for kalshi starter Added `QUICKSTART_NOTES.md` with a step-by-step checklist: creating `.env`, installing dependencies, checking the environment and running `main.py`. --- QUICKSTART_NOTES.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 QUICKSTART_NOTES.md diff --git a/QUICKSTART_NOTES.md b/QUICKSTART_NOTES.md new file mode 100644 index 0000000..96776f9 --- /dev/null +++ b/QUICKSTART_NOTES.md @@ -0,0 +1,28 @@ +# Kalshi Starter – Quickstart Notes + +This file complements the main README and provides a short step-by-step checklist. + +## 1. Create an environment file + + cp env.sample .env + +## 2. Create and activate a virtual environment + + python -m venv .venv + source .venv/bin/activate # On Windows: .venv\Scripts\activate + +## 3. Install dependencies + + pip install -r requirements.txt + +## 4. Verify your environment + + python check_env.py + +## 5. Run the main example + + python main.py + +--- + +This file does not replace the main README. It is intended as a quick, copy-paste friendly checklist for new users of the Kalshi starter code.