Getting Started

This guide assumes jiang is installed and available on your PATH. If not, start with Installation.

Write a Program

Create hello.jiang:

Int add(Int a, Int b) {
    return a + b;
}

Int main() {
    return add(40, 2);
}

A Jiang function always has a return type. The process entry point is main; returning 42 gives the host process exit code 42.

Compile to an Executable

jiang hello.jiang -o hello

Run it:

./hello
echo $?

The result should be 42.

Inspect LLVM IR

During language development it is often useful to inspect the generated LLVM IR:

jiang --emit-llvm hello.jiang

Use -o to write the IR to a file:

jiang --emit-llvm hello.jiang -o hello.ll

Language Shape

Jiang source is declaration-oriented. A small file usually contains type declarations, functions, and a main function:

struct Pair {
    Int left;
    Int right;
}

Int sum_pair(Pair pair) {
    return pair.left + pair.right;
}

Int main() {
    Pair pair = Pair(left = 20, right = 22);
    return sum_pair(pair);
}

Next, read the syntax overview and types guide.