variablelab/theatre
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

More docs

Browse source
This commit is contained in:
Aria Minaei 2021-10-05 12:22:43 +02:00
parent f7cc267746
commit 5873e65d4d
5 changed files with 32 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
packages/dataverse-experiments/README.md Normal file
View file

@ -0,0 +1,5 @@
# Dataverse experiments
This package contains some experiments in [@theatre/dataverse](../dataverse). We are keeping these experiments in the main branch so they don't bitrot.
The experimental `AbstractDerivation` in this package uses some ideas from [incremental](https://github.com/janestreet/incremental/blob/master/src/incremental_intf.ml).

5
packages/dataverse/README.md
View file

@ -4,3 +4,8 @@ Dataverse is the reactive dataflow library [Theatre.js](https://www.theatrejs.co
Dataverse is currently an internal library. It is used within Theatre.js, but its API is not exposed through Theatre. This is so that we can iterate on the reactive internals while keeping the public API stable. We plan to eventually have an LTS release, but for now, expect a high release cadence and API churn in dataverse while the API in Theatre.js remains stable.
## Documentation
* API Docs: [docs.theatrejs.com/api/dataverse](https://docs.theatrejs.com/api/dataverse.html)
* Guide: TODO

12
packages/playground/README.md Normal file
View file

@ -0,0 +1,12 @@
# The playground
The playground is the quickest way to hack on the internals of Theatre. It uses a simple ESBuild config that builds all the related packages in one go, so whether you're changing `@theatre/core` or `@theatre/dataverse`, you can see the results immediately.
## How to use
Simply run `yarn run serve` in this folder to start the dev server.
The first time you run `serve`, an `src/index.ts` file will be created. This file won't be comitted to the repo, so you're free to change it.
There are some shared playgrounds in `src/shared` which are committed to ther epo. You can make your own playgrounds in `src/personal` which will be `.gitignore`d.

2
packages/r3f/README.md
View file

@ -4,4 +4,4 @@ A [Theatre.js](https://github.com/AriaMinaei/theatre) extension for [THREE.js](h
## Documentation
Docs and video tutorials are [here](https://docs.theatrejs.com/r3f/).
Docs and video tutorials are [here](https://docs.theatrejs.com/extensions/r3f/).

9
packages/react/README.md Normal file
View file

@ -0,0 +1,9 @@
# @theatre/react
Utilities for using [Theatre.js](https://www.theatrejs.com) with React.
## Documentation
* API Docs: [docs.theatrejs.com/api/react](https://docs.theatrejs.com/api/react.html)
* Guide: TODO