Skip to main content

Installation

Zynx is currently built from source. Official binaries will be available in the future.

1. Prerequisites​

  • Tools: git, make, python3 (3.8+).
  • C Toolchain: clang (recommended) or gcc.
  • Dependencies: libclang-dev (required for bindgen and ffi).

Platform Commands​

  • macOS: xcode-select --install (and optionally brew install llvm).
  • Linux (Debian/Ubuntu): sudo apt install build-essential clang libclang-dev git make python3.
  • Windows: Use WSL2 and follow the Linux instructions.

2. Build and Install​

Clone the repository and build the compiler:

git clone https://github.com/fenze/zynx.git
cd zynx
make

Install to System​

By default, Zynx installs to /usr/local.

sudo make install

To use a custom path (e.g., ~/.local):

PREFIX=$HOME/.local make install
export PATH="$HOME/.local/bin:$PATH"

3. Verification​

Confirm the installation:

zynx --version

Run Tests (Optional)​

python3 tests/run.py

4. Troubleshooting​

  • Missing C Compiler: Ensure clang or gcc is in your PATH.
  • Missing libclang: Install libclang-dev or equivalent for your platform.
  • zynx not found: Ensure the installation bin directory is in your PATH.