Skip to content

Commit

Permalink
Improvements to READMEs (#279)
Browse files Browse the repository at this point in the history
  • Loading branch information
iwoplaza authored Sep 9, 2024
1 parent 0c6ff52 commit b6a7cc0
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 13 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,33 @@
![TypeGPU (light mode)](./apps/typegpu-docs/public/typegpu-logo-light.svg#gh-light-mode-only)
![TypeGPU (dark mode)](./apps/typegpu-docs/public/typegpu-logo-dark.svg#gh-dark-mode-only)

[Website](https://docs.swmansion.com/TypeGPU)[Live Examples](https://docs.swmansion.com/TypeGPU/examples)[Documentation](https://docs.swmansion.com/TypeGPU/guides/getting-started)
[Website](https://docs.swmansion.com/TypeGPU)[Documentation](https://docs.swmansion.com/TypeGPU/guides/getting-started)

</div>

**TypeGPU** is a TypeScript library simplifying the WebGPU API and WGSL with zero-cost abstractions, type-safe data transfer and dependency injection.
**TypeGPU** is a TypeScript library that enhances the WebGPU API, allowing resource management in a type-safe, declarative way.

<div align="center">
<video width="512" autoplay muted loop src="https://github.com/user-attachments/assets/4dcbdcc6-5aa0-4adc-a40c-468c750d4d76"></video>
</div>

## Documentation

We created a set of guides and tutorials to get you up and running fast. Check out our [Official Docs](https://docs.swmansion.com/TypeGPU/guides/getting-started)!

## What's next?

- [Join the Software Mansion Community Discord](https://discord.swmansion.com) to chat about TypeGPU or other Software Mansion libraries.

## TypeGPU is created by Software Mansion

[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=typegpu-github 'Software Mansion')](https://swmansion.com)

Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help you build your next dream product – [Hire us](https://swmansion.com/contact/projects?utm_source=typegpu&utm_medium=readme).

## Repository structure
**Packages**:
- [packages/typegpu](/packages/typegpu) - the core library.
- [packages/typegpu-wgsl-parser](/packages/typegpu-wgsl-parser) - a WGSL parser, aiding in unit tests and pretty code formatting in DEV.

**Apps**:
- [apps/typegpu-docs](/apps/typegpu-docs) - the documentation webpage, along with live examples.
- [apps/typegpu-docs](/apps/typegpu-docs) - the documentation webpage.
17 changes: 8 additions & 9 deletions packages/typegpu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,26 @@
![TypeGPU (light mode)](/apps/typegpu-docs/public/typegpu-logo-light.svg#gh-light-mode-only)
![TypeGPU (dark mode)](/apps/typegpu-docs/public/typegpu-logo-dark.svg#gh-dark-mode-only)

[Website](https://docs.swmansion.com/TypeGPU)[Live Examples](https://docs.swmansion.com/TypeGPU/examples)[Documentation](https://docs.swmansion.com/TypeGPU/guides/getting-started)
[Website](https://docs.swmansion.com/TypeGPU)[Documentation](https://docs.swmansion.com/TypeGPU/guides/getting-started)

</div>

TypeScript library simplifying the WebGPU API and WGSL with zero-cost abstractions, type-safe data transfer and dependency injection.
**TypeGPU** is a TypeScript library that enhances the WebGPU API, allowing resource management in a type-safe, declarative way.

<div align="center">
<video autoplay muted loop src="https://github.com/user-attachments/assets/4dcbdcc6-5aa0-4adc-a40c-468c750d4d76"></video>
</div>

## Documentation

We created a set of guides and tutorials to get you up and running fast. Check out our [Official Docs](https://docs.swmansion.com/TypeGPU/guides/getting-started)!

## Live Examples

To show the flexibility and simplicity of **TypeGPU**, we provide the [Live Examples](https://docs.swmansion.com/TypeGPU/examples) platform. It allows you to change the example
code in real-time!

## What's next?

- [Join the Software Mansion Community Discord](https://discord.swmansion.com) to chat about TypeGPU or other Software Mansion libraries.

## TypeGPU is created by Software Mansion

[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=react-native-reanimated-github 'Software Mansion')](https://swmansion.com)
[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=typegpu-github 'Software Mansion')](https://swmansion.com)

Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help you build your next dream product – [Hire us](https://swmansion.com/contact/projects?utm_source=reanimated&utm_medium=readme).
Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help you build your next dream product – [Hire us](https://swmansion.com/contact/projects?utm_source=typegpu&utm_medium=readme).

0 comments on commit b6a7cc0

Please sign in to comment.