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

More contribution docs

Browse source
This commit is contained in:
Aria Minaei 2021-10-06 10:21:55 +02:00
parent c336d2e397
commit ef91bf7229
2 changed files with 21 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

6
packages/playground/README.md
View file

@ -1,12 +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.
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 you _don't_ have to run a bunch of build commands separately to start developing.
## 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.
The first time you run `serve`, an `src/index.ts` file will be created. This file is the entry point, and it 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.
There are some shared playgrounds in `src/shared` which are committed to the repo. You can make your own playgrounds in `src/personal` which will be `.gitignore`d.