Skip to content

[DOC] Add QBE dependency installation instructions to README #41

Description

@Prestgg1

Issue

The README documents building AzLang but doesn't mention the required system dependencies:

cargo build --release

However, building requires:

  • QBE (afterburner backend)
  • Linux: binutils (assembler) and ld.lld (linker)
  • Windows: MASM/NASM assembler and lld.link

Current State

  • Dependencies mentioned in README: Partially
  • Installation instructions: Missing

Recommendation

Add a "Building from Source" section with platform-specific instructions:

## Building from Source

### Prerequisites
- Rust toolchain (see rustup.rs)
- QBE: https://c9x.me/compile/
- Linux: `sudo apt install binutils clang lld`
- macOS: `brew install qbe binutils`
- Windows: Install MASM/NASM and LLVM's lld

### Build
```bash
cargo build --release

**Labels:** documentation, good first issue

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions