/ Installation
Documentation

Getting Started

Language Guide

SDL2 and Graphics

CLI Reference

Installation

Vexel v0.1 is available as a self-contained Windows executable. No Python installation or other dependencies are needed to run compiled Vexel programs.

Windows

Step 1. Download the binary

Download vexel.exe from the downloads page or directly from the GitHub release.

Step 2. Add to PATH

Move the executable to a folder that is on your system PATH. A common location is C:\tools\. If that folder does not exist, create it and add it to PATH:

  1. Open System Properties and click Environment Variables
  2. Under User variables, select Path and click Edit
  3. Click New and enter the path to your folder (e.g. C:\tools)
  4. Click OK on all dialogs and restart your terminal

Step 3. Verify

vexel --version

You should see output like Vexel 0.1.0.

Build from Source

Building from source works on Windows, Linux, and macOS and requires Python 3.12 or later.

Prerequisites

  • Python 3.12 or later
  • llvmlite — Python bindings for LLVM
  • LLVM 14 or later (installed by llvmlite automatically)

Clone and install

# Clone the repository
git clone https://github.com/Justme-Cliff/vexel
cd vexel

# Install dependencies
pip install llvmlite

# Run a Vexel program directly
python main.py run examples/hello.vx

Optional: SDL2 for graphics

To use SDL2 graphics features, you need the SDL2 runtime library in your project directory. A helper script is provided:

python setup_sdl2.py

Next Steps

Hello World

Write and run your first Vexel program.

Variables and Types

Learn about Vexel's type system.

CLI Reference

All compiler commands and flags.