crawfish

simple programming language for the layman

Caution

The compiler can't compile crawfish programs yet.

Installation (Building from Source)

Dependencies

• Rust Compiler
• LLVM

Steps

1. Install Rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

2. Install llvm-config-20 and libpolly-20-dev

wget https://apt.llvm.org/llvm.sh
chmod +x llvm.sh
sudo ./llvm.sh 20
sudo apt install libpolly-20-dev

3. Git clone the repository

git clone https://github.com/simontran7/crawfish.git

4. cd into the crawfish/ directory, then build the project with GNU Make

cd crawfish/
cargo build --release

5. Move the target/release/crawfish binary to a desired location (e.g. in /Users/<your name>), then add it to your PATH by adding the following line to your .bashrc file

# in your .bashrc
export PATH=$PATH:<path to the crawfish compiler executable>

Usage

Crawfish compiler

Usage:
    crawfish [OPTIONS] <COMMAND> [ARGS...]

Command:
    compile <file>.crw            compile the current file

Options:
    -h, --help                    print possible commands
    -v, --version                 print compiler version

See docs/tour-of-crawfish.md for a tour of the language.