INSTALL.md

Installation Complete! 🎉

The otter command is now installed and ready to use!

Quick Start

# Run a program
otter run examples/hello.ot

# Build an executable
otter build examples/hello.ot

# Profile memory usage
otter profile memory examples/hello.ot

# List benchmarks
otter bench list examples

# Format code
otter fmt

Installation Location

The otter binary is installed at:

~/.cargo/bin/otter

Make sure ~/.cargo/bin is in your PATH. If you're using zsh/bash, add this to your ~/.zshrc or ~/.bashrc:

export PATH="$HOME/.cargo/bin:$PATH"

Usage Examples

# Run with debug output
otter run examples/hello.ot --debug

# Run with timing information
otter run examples/hello.ot --time

# Build optimized release binary
otter build examples/hello.ot --release

# Dump tokens during compilation
otter run examples/hello.ot --dump-tokens

# Dump AST during compilation
otter run examples/hello.ot --dump-ast

# Dump LLVM IR
otter run examples/hello.ot --dump-ir

Updating

To update the installed binary:

cargo install --path . --bin otter --force