From 996493f6b3a1cd06733b4dccbabe731ca0749337 Mon Sep 17 00:00:00 2001 From: Marcin Hawryluk <70582973+mhawryluk@users.noreply.github.com> Date: Thu, 13 Feb 2025 16:07:24 +0100 Subject: [PATCH] docs: Update Repository structure in Readme (#866) --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3aacb805a..1b06eab49 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,16 @@ Since 2012 [Software Mansion](https://swmansion.com) is a software agency with e ## Repository structure **Packages**: -- [packages/typegpu](/packages/typegpu) - the core library. +- [packages/typegpu](/packages/typegpu) - The core library. +- [packages/unplugin-typegpu](/packages/unplugin-typegpu) - Build plugins for TypeGPU. +- [packages/tgpu-gen](/packages/tgpu-gen) - CLI tool for automatic TypeGPU code generation. +- [packages/tgpu-jit](/packages/tgpu-jit) - Just-In-Time transpiler for TypeGPU. +- [packages/tinyest](/packages/tinyest) - Type definitions for a JS embeddable syntax tree. +- [packages/tinyest-for-wgsl](/packages/tinyest-for-wgsl) - Transforms JavaScript into its *tinyest* form, to be used in generating equivalent (or close to) WGSL code. +- [packages/tgpu-wgsl-parser](/packages/tgpu-wgsl-parser) - WGSL code parser. +- ~~[packages/rollup-plugin](/packages/rollup-plugin) - Rollup plugin for TypeGPU.~~ (replaced by *unplugin-typegpu*) + +- [packages/tgpu-dev-cli](/packages/tgpu-dev-cli) - Development tools for packages in the monorepo. **Apps**: -- [apps/typegpu-docs](/apps/typegpu-docs) - the documentation webpage. +- [apps/typegpu-docs](/apps/typegpu-docs) - The documentation, examples and benchmarks webpage.