> Development branch documentation · commit 327c05c78d2f528e4f4a679fcc7a77d9aa161f48
> Package versions: @zenfg/webgpu 0.1.0, @zenfg/snapshot 0.1.0, @zenfg/inspector 0.1.0, zenfg 0.1.0, zenfg-snapshot 0.1.0
> Source: https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/docs/README.md

# Getting started with ZenFG

Choose a path for your application. ZenFG coordinates graph-visible GPU work;
your application owns the device, rendering policy, and presentation.

| Goal | Start here | What you will get |
| --- | --- | --- |
| Integrate TypeScript and WebGPU | [WebGPU quick start](/zenfg/docs/packages/webgpu.md#quick-start) | A clear-only presentation frame |
| Integrate Rust and wgpu | [Rust quick start](/zenfg/docs/packages/zenfg.md#quick-start) | A CPU-only compiled graph, followed by device-backed recipes |
| Read or produce Snapshot data | [TypeScript Snapshot](/zenfg/docs/packages/snapshot.md) or [Rust Snapshot](/zenfg/docs/packages/zenfg-snapshot.md) | Validated, canonical portable diagnostics |
| Embed a visual debugger | [Inspector quick start](/zenfg/docs/packages/inspector.md#quick-start) | A browser workbench for your captures |

## Before you start

Read [Compatibility](/zenfg/docs/compatibility.md) for package and toolchain requirements.
Browser FrameGraph execution needs native WebGPU on HTTPS or localhost. Snapshot
processing and the Inspector do not require a GPU. Pin exact beta package
versions and check that your producer and consumer agree on the Snapshot wire version.

## Continue by task

- Understand [Core concepts](/zenfg/docs/concepts.md): recording, content validity, dependencies, retention, and resource lifetimes.
- Follow the [complete TypeScript recipes](/zenfg/docs/guides/examples.md) for transient resources, imported storage, persistent state, external submissions, snapshots, and GPU timing.
- Use the [Inspector workbench guide](/zenfg/docs/guides/inspector.md) and [theme guide](/zenfg/docs/guides/themes.md).
- Read the [Snapshot specification](/zenfg/docs/reference/snapshot.md) for the portable wire contract.
- Explore the [Examples](https://uinosoft.github.io/zenfg/playground/) or open the [standalone Inspector](https://uinosoft.github.io/zenfg/inspector/).

## API reference

[TypeScript API](/zenfg/docs/api/index.md) is generated from
public source comments. For an installed version, follow its package manifest's
`exports` to the included declarations and source. Rust API reference is on
docs.rs; each crate README links its exact version.

## Versions and contributing

The website follows the development branch. Installed READMEs, packaged examples,
and per-package release tags preserve documentation for published versions.
See [beta.4 migration guidance](/zenfg/docs/migration/timing-snapshot-1-2.md) and the [changelog](/zenfg/docs/changelog.md).

For repository work, read [Contributing](https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/CONTRIBUTING.md), the
[documentation workflow](https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/docs/documentation.md), and the [release process](https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/docs/release-process.md).