INSTALL.md

Installation

We do not currently have a binary available for installation. However, you can build it yourself from source or install it via the AUR if you are on Arch Linux.

Platforms

• Arch Linux
• Manual from Source
• Windows (Work in Progress)
• macOS (Work in Progress)

Arch Linux

You can install vterm via the AUR:

yay -S vterm-git

or if you prefer paru:

paru -S vterm-git

Dependencies

To build vterm on Arch Linux, you need the following dependencies:

• vulkan-icd-loader (or vulkan-icd-loader-git from AUR)
• cargo (or rust-nightly-bin, cargo-git, rustup-git, rust, rustup from AUR) (make)
• git (or git-git from AUR) (make)
• rustup (or rustup-git from AUR) (make)
• vulkan-headers (or vulkan-headers-git from AUR) (make)

Optional:

• npm (or npm-git, bun, deno from AUR) (make)

Manual from Source

Dependencies

To build vterm from source, you need the following dependencies:

• vulkan-icd-loader
• cargo
• git
• just
• rustup
• vulkan-headers

Building

To run the binary directly, use:

cargo run
cargo run --release

Optimized Build

For a highly optimized build, you have several options:

1. Using a JavaScript package manager: You can use bun, npm, deno, or any JavaScript package manager to run the build and run commands:

   bun run build

2. Manually:

   cargo build -Z build-std=std,panic_abort -Z build-std-features=panic_immediate_abort --release

Windows (Work in Progress)

Support for Windows is currently a work in progress. Please check back later for updates.

macOS (Work in Progress)

Support for macOS is currently a work in progress. Please check back later for updates.