# circ

> A small declarative language for digital logic circuits. Programs are flat lists of declarations: name an input pin, instantiate a gate, wire its ports to signals from other components. The compiler (`circ-compile`) produces a self-contained WebAssembly module simulating the circuit, plus optional ASCII schematics and truth tables.

Important notes:

- `circ` is a v0 — single-bit signals only, no clocked registers, no multi-bit buses.
- Primitives are `and`, `not`, `led`, and `wire`; macros for `or`, `nand`, `nor`, `xor`, and `xnor` expand to those primitives at compile time.
- Sub-circuits live in their own `.circ` files and are pulled in with `import`.

## Docs

- [Landing page](https://circ-lang.org/index.md): What `circ` is, what it isn't, where it runs.
- [Tour](https://circ-lang.org/tour.md): Seven progressive examples from a single NOT gate to a full-adder built from two half-adders.
- [Language reference](https://circ-lang.org/reference.md): Every keyword, every diagnostic code, the rules the validator enforces.
- [Getting Started](https://circ-lang.org/reference/getting-started.md): Install the compiler, write your first circuit, and drive it from Node.
- [Circuit File Format](https://circ-lang.org/reference/circuit-format.md): The .circ language: declarations, ports, components, and built-ins.
- [WASM Runtime API](https://circ-lang.org/reference/wasm-api.md): The export and import contract for every compiled .wasm artifact.
- [ASCII Preview](https://circ-lang.org/reference/preview.md): Render circuits as deterministic ASCII schematics with --preview.
- [Download](https://circ-lang.org/download.md): Pre-built `circ-compile` binaries for Linux, macOS, and Windows.

## Examples

- [Examples gallery](https://circ-lang.org/examples.md): Curated `.circ` programs with their `--preview` output.

## Optional

- [Architecture](https://github.com/jeffersonmourak/circ-compiler/blob/main/DOCS/architecture.md): Compiler pipeline and layering, useful when contributing.
- [Design decisions](https://github.com/jeffersonmourak/circ-compiler/blob/main/DOCS/decisions/index.md): Rationale for the major language and runtime choices.
- [Source repository](https://github.com/jeffersonmourak/circ-compiler): Issues, pull requests, and the canonical `DOCS/` directory.