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

Fix readme

Browse source
This commit is contained in:
Aria Minaei 2021-06-18 21:15:48 +02:00
parent b2d1f15446
commit 463c226eb6
1 changed files with 6 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
theatre/studio/README.md
View file

@ -1,29 +1,20 @@
# Theatre.js # Theatre.js
Theatre.js is an animation library for high-fidelity motion graphics. It is Theatre.js is an animation library for high-fidelity motion graphics. It is designed to help you express detailed animation, enabling you to create intricate movement, and convey nuance.
designed to help you express detailed animation, enabling you to create
intricate movement, and convey nuance.
Theatre can be used both programmatically _and_ visually: Theatre can be used both programmatically _and_ visually:
![Video showing a browser window containing three divs falling from the middle of the screen, and bouncing back up, animated with the help of Theatre.js](https://docs.theatrejs.com/public/preview-1.gif) ![Video showing a browser window containing three divs falling from the middle of the screen, and bouncing back up, animated with the help of Theatre.js](https://docs.theatrejs.com/public/preview-1.gif)
Theatre works with all rendering stacks. You can use it to animate DOM elements, Theatre works with all rendering stacks. You can use it to animate DOM elements, THREE.js objects, or any kind of JavaScript variable.
THREE.js objects, or any kind of JavaScript variable.
## Guide ## Guide
Read the guide at [docs.theatrejs.com](https://docs.theatrejs.com) TODO
## License ## License
Theatre.js is released under the LGPL-v2.1 License and is free to use in Your use of Theatre.js is governed under the Apache License Version 2.0:
personal _and_ commercial projects. Some of the sub-libraries can also be used
independently under the Apache License 2.0 license.
### Bundling with Webpack, Rollup, parcel, etc. * Theatre's core (`@theatre/core`) is released under the Apache License. Same goes for most packages in this repository.
* The studio (`@theatre/studio`) is released under the AGPL 3.0 License. This is the package that you use to edit your animations, setup your scenes, etc. You only use the studio during design/development. Your project's final bundle only includes `@theatre/core`, so only the Apache License applies.
You do not need to configure your build system to be in compliance with the LGPL
license. Theatre.js is already built in a way that all use of it with any build
system is already compliant with the license terms. See
`theatre/studio/src/entries/studio.ts` to learn how this is implemented.