@mateuszjs/magic-render 0.1.0-next.7 → 0.1.0-next.70

package/README.md

@@ -17,3 +17,32 @@ Each Pull Request has to be merged with squash, the following naming convention
 | `fix(pencil): stop graphite breaking when too much pressure applied`                                                                                                                             | patch/fix                                                                                                   |
 | `feat(pencil): add 'graphiteWidth' option`                                                                                                                                                       | minor/feature                                                                                               |
 | `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | major/breaking release <br /> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |
+
+## Testing locally:
+
+```bash
+npm link
+```
+
+Creates link in global registry on your machine.
+
+Then call
+
+```bash
+npm link @mateuszjs/magic-render
+```
+
+In the repo where you want to put local version of the package.
+Remember to build package to see an update!
+
+# Glossary
+
+## Units:
+
+viewport - value expressed in pixels which will be rendered on the screen. This is exavtly how many pixels will be rendered, already includes retina. It's device physical pixel, not CSS pixel.
+
+world - values expressed in abstract units used in project. This unit is absolute, never changes, does not depend on anything. This is how all sizes of all assets and assets' properties are kept expressed.
+
+texel - value expressed in texels, ususally in SDF texture texels. It corresponds to how many texels will be used in the SDF texture.
+
+Often when no unit is used, value is expressed in world coordinates OR the unit is obvious from the function context.