Skip to content

Setup.md

Latest commit

 

History

History
163 lines (114 loc) · 4.52 KB

Setup.md

File metadata and controls

163 lines (114 loc) · 4.52 KB
Raw

Development Environment Installation Guide

This document provides instructions to set up the development environment for Wave, AOSP, Whale, and AriaJDK on Ubuntu 22.04.5 LTS or later.

The commands below assume x86-64 Ubuntu and Bash. To build Wave only, follow section 1; the AOSP, Whale, and AriaJDK sections are separate. For prebuilt releases on Linux, macOS, or Windows, use the Wave installation guide.

1. Wave Development Environment

Wave uses LLVM 21 (llvm/Cargo.toml). This guide uses Rust 1.89.0 to match Wave CI.

1-1. Install LLVM 21 (Required)

sudo apt update
sudo apt install -y wget software-properties-common lsb-release gnupg
wget https://apt.llvm.org/llvm.sh
chmod +x llvm.sh
sudo ./llvm.sh 21
sudo apt install -y llvm-21-dev clang-21 lld-21

1-2. Configure LLVM Environment Variables

echo 'export LLVM_SYS_211_PREFIX=/usr/lib/llvm-21' >> ~/.bashrc
echo 'export LLVM_CONFIG_PATH=/usr/lib/llvm-21/bin/llvm-config' >> ~/.bashrc
source ~/.bashrc

1-3. Install Rust 1.89.0

sudo apt install -y curl build-essential pkg-config libssl-dev ca-certificates
curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain 1.89.0
source "$HOME/.cargo/env"
rustup target add x86_64-unknown-linux-gnu
rustup default 1.89.0

1-4. Install Python (Optional, for x.py)

The Cargo build below does not need Python. The optional x.py helper needs Python 3.11 or later; Ubuntu 22.04's default Python 3.10 is insufficient. Check the version before using x.py; installing the toml package does not replace Python's tomllib module.

sudo apt install -y python3
python3 --version

1-5. Install Git

sudo apt install -y git

1-6. Install IDEs (Optional)

sudo apt install snapd
sudo snap install rustrover --classic
sudo snap install --classic code

1-7. Validate Build

Run this from the directory where you want to keep the source. If you already have a Wave checkout, skip git clone and change into that checkout instead. The Rust override applies only to this checkout.

git clone https://github.com/wavefnd/Wave.git
cd Wave
rustup override set 1.89.0
export LLVM_SYS_211_PREFIX=/usr/lib/llvm-21
export LLVM_CONFIG_PATH=/usr/lib/llvm-21/bin/llvm-config
"$LLVM_CONFIG_PATH" --version
rustc --version
cargo build --locked
./target/debug/wavec --version

cargo build --locked uses the committed dependency versions. The development compiler is written to target/debug/wavec; the version command verifies that executable directly, without requiring a global installation.

2. AOSP Development Environment

2-1. Install Required Packages

sudo apt install -y git-core gnupg flex bison build-essential zip curl zlib1g-dev \
libc6-dev-i386 x11proto-core-dev libx11-dev lib32z1-dev \
libgl1-mesa-dev libxml2-utils xsltproc unzip fontconfig

2-2. Install Repo

sudo apt install -y repo

AOSP setup follows the official Android documentation. No additional dependencies are required beyond these packages.

3. Whale Development Environment

Whale only requires Rust.

3-1. Install Rust

sudo apt install rustc cargo
rustup target add x86_64-unknown-linux-gnu
rustup default 1.86.0

3-2. Install Git

sudo apt install git

4. AriaJDK Development Environment

AriaJDK uses Rust and Kotlin.

4-1. Install Rust

sudo apt install rustc cargo
rustup target add x86_64-unknown-linux-gnu
rustup default 1.86.0

4-2. Install Kotlin and JDK

sudo apt install -y wget apt-transport-https gpg
wget -qO - https://packages.adoptium.net/artifactory/api/gpg/key/public | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/adoptium.gpg > /dev/null
echo "deb https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | sudo tee /etc/apt/sources.list.d/adoptium.list
sudo apt update
sudo apt install -y temurin-17-jdk
sudo snap install kotlin --classic

4-3. Install Git

sudo apt install git

5. Using the Installation Script

Run this optional script from the root of the setup repository. It installs tools for all four projects and changes the default Rust toolchain. For the current Wave source requirements, follow the manual Wave steps in section 1 above.

chmod +x install.sh
./install.sh