chore: add scripts

Author: nos1dot618

.gitignore

@@ -1,2 +1,3 @@
 .idea/
-cmake-build-debug/
+cmake-build-debug/
+venv/

README.md

@@ -1,24 +1,47 @@
 ## Getting Started
 
+### Prerequisites
+
+- **CMake** (version 3.16+ recommended)
+- **Python 3.8+** (for development environment and tooling)
+- A C++17 capable compiler (e.g. `g++`, `clang++`, or MSVC on Windows)
+
+### Setup
+
+#### GNU/Linux
+
 ```bash
-mkdir build
-cd build
-cmake ..
-make
+bash ./scripts/setup.sh
+```
+
+#### Windows (PowerShell)
+
+```powershell
+. .\scripts\setup.ps1
 ```
 
+---
+
 ## Usage
 
+After building, you can run the interpreter with:
+
 ```bash
-usage: lbd [options]
+lbd [options]
+```
 
-options:
+### Options
+
+```
 -f, --file <filename>   Specify input source file to run
 -h, --help              Show this help message and exit
 -d, --debug             Enable debug mode
--r, --repl              Run in interactive REPL node
+-r, --repl              Run in interactive REPL mode
 ```
 
-> TODO: Add build instructions for Windows as well.
+---
+
+### TODO
 
-> TODO: Add small script to print all TODOs and there Loc.
+- TODO: Add build instructions for Windows (MSVC toolchain).
+- TODO: Provide better examples (e.g., Advent of Code snippets).

requirements.txt

@@ -0,0 +1 @@
+pathspec # used in scripts/dump_todo.py

scripts/dump_todo.py

@@ -0,0 +1,43 @@
+"""
+This script recursively scans the current directory for lines containing "TOD0:" and
+prints them in the format relative_filepath:line_number: TOD0: tod0 text.
+It skips scanning itself, respects .gitignore rules using the pathspec library, and
+ignores files that cannot be read due to encoding or permission issues.
+P.S. TOD0 is intentionally misspelled here, and in above description.
+"""
+
+import os
+import pathspec
+
+BASE_DIR = "."
+SCRIPT_PATH = os.path.abspath(__file__)  # Absolute path of this script
+
+EXCLUDE_PATHS = {
+    os.path.relpath(SCRIPT_PATH, BASE_DIR),
+    ".git",
+}
+
+GITIGNORE_PATH = os.path.join(BASE_DIR, ".gitignore")
+spec = None
+if os.path.exists(GITIGNORE_PATH):
+    with open(GITIGNORE_PATH, "r", encoding="utf-8") as f:
+        spec = pathspec.PathSpec.from_lines("gitwildmatch", f)
+
+for root, _, files in os.walk(BASE_DIR):
+    for filename in files:
+        filepath: str = os.path.join(root, filename)
+        rel_path: str = os.path.relpath(filepath, BASE_DIR)
+        if any(rel_path == p or rel_path.startswith(p + os.sep) for p in EXCLUDE_PATHS):
+            continue
+        if spec and spec.match_file(rel_path):
+            continue
+        try:
+            with open(filepath, "r", encoding="utf-8") as f:
+                for lineno, line in enumerate(f, start=1):
+                    if "TODO:" in line:
+                        todo_index = line.index("TODO:")
+                        todo_text = line[todo_index:].strip()
+                        print(f"{rel_path}:{lineno}: {todo_text}")
+        except (UnicodeDecodeError, PermissionError):
+            # Skip files that can’t be read as text
+            continue

scripts/setup.ps1

@@ -0,0 +1,24 @@
+# This script sets up the project which includes building the CMake project, and
+# creating python environment for development.
+# Should be run from within the PROJECT ROOT.
+
+# --- CMake Project Setup ---
+$BuildDir = "cmake-build-debug"
+if (!(Test-Path $BuildDir))
+{
+    New-Item -ItemType Directory -Path $BuildDir | Out-Null
+}
+Set-Location $BuildDir
+cmake ..
+cmake --build .
+Set-Location ..
+
+# --- Python Environment Setup ---
+$VenvDir = "venv"
+if (!(Test-Path $VenvDir))
+{
+    python -m venv $VenvDir
+}
+. .\$VenvDir\Scripts\Activate.ps1
+python -m pip install --upgrade pip
+pip install -r requirements.txt

scripts/setup.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+# This script sets up the project which includes building the CMake project,
+# and creating a Python environment for development.
+# Should be run from within the PROJECT ROOT.
+
+set -e
+
+# --- CMake Project Setup ---
+BuildDir="cmake-build-debug"
+if [[ ! -d "$BuildDir" ]]; then
+    mkdir "$BuildDir"
+fi
+cd "$BuildDir"
+cmake ..
+cmake --build .
+cd ..
+
+# --- Python Environment Setup ---
+VenvDir="venv"
+if [[ ! -d "$VenvDir" ]]; then
+    python3 -m venv "$VenvDir"
+fi
+source "$VenvDir/bin/activate"
+python -m pip install --upgrade pip
+if [[ -f "requirements.txt" ]]; then
+    pip install -r requirements.txt
+fi