Quick Start

Installation

Add lockfree to your .nimble file or install via Nimble:

nimble install lockfree

Basic Usage

Import the package in your Nim code:

src/main.nim

import lockfree

echo hello()

Architecture Flowchart

graph LR
    User[Developer / Caller] --> API[lockfree API]
    API --> Core[Internal Logic]
    Core --> Result[Return Value]

Running Tests & Building

Use just as the canonical command runner:

just test    # Run full test suite
just lint    # Run pre-commit & formatting checks
just fmt     # Auto-format with nph
just docs    # Launch local documentation server