Installation

Build Zinc and its language adapters from source

Registry publishing is still on the roadmap. Use a repository checkout for the core and adapters.

Build the core

Install Rust through rustup and a C compiler toolchain. This checkout pins Rust 1.99.0 with rustfmt and Clippy; rustup installs them when you run Cargo here. The core library supports Rust 1.85 or later. Linux and macOS are supported.

git clone https://github.com/ossl-dev/zinc
cd zinc
cargo build --release -p zinc-core --lib --locked

The Cargo workspace writes target/release/libzinc_core.so on Linux or target/release/libzinc_core.dylib on macOS. The C header, include/zinc.h, is checked in. Regeneration is only needed after changing C exports; see contributing.

Build an adapter

Run these commands from the repository root:

Language	Source setup
Rust	cargo add zinc-core --path /path/to/zinc/core
Python	python3 -m pip install -e 'adapters/python[numpy]'
Node.js	cd adapters/node && npm ci && npm run build
Bun	Import adapters/bun/src/index.ts in your Bun program
Deno	Import adapters/deno/src/mod.ts; use adapters/deno/deno.json for its import map
Go	Use a local replace zinc => /path/to/zinc/adapters/go in your module, then go get zinc
C++	cmake -S adapters/cpp -B target/cpp-tests && cmake --build target/cpp-tests
Java	cd adapters/java && mvn install to install the jar in your local Maven repository
C#	Add a project reference to adapters/csharp/Zinc.csproj

See the adapter references for runtime requirements and imports. Node builds its core into the native addon. Python, Bun, and Deno currently resolve the shared library relative to their source checkout. Moving those adapters elsewhere requires changing their loader paths.

Go links against the repository’s target/release directory. C++, Java, and C# need the shared library available to the native loader. For development, set the loader path:

# Linux
export LD_LIBRARY_PATH="$PWD/target/release:${LD_LIBRARY_PATH:-}"
# macOS
export DYLD_LIBRARY_PATH="$PWD/target/release:${DYLD_LIBRARY_PATH:-}"

Verify

cargo test --workspace --all-targets --locked
python3 -m pip install -e 'adapters/python[test]'
bash tests/runner.sh

The runner tests installed language runtimes and reports missing tools. CI installs all adapter runtimes on Linux and macOS. For a cross-process example, follow the quickstart.