|
1 | 1 | # renderlayer |
2 | 2 |
|
3 | | -Light, Modern, Stable - 3D Rendering Layer for the Web |
| 3 | +WebGL 2 rendering library targeting modern browsers. |
4 | 4 |
|
5 | 5 | [![NPM version][npm-badge]][npm-url] |
6 | 6 | [![License][license-badge]][license-url] |
7 | 7 | [![CI][ci-badge]][ci-url] |
8 | 8 | [![Coverage][codecov-badge]][codecov-url] |
9 | 9 |
|
10 | | -## Scripts |
11 | | - |
12 | | -| Action | Command | Description | |
13 | | -| ------------- | ----------------------- | ---------------------------------- | |
14 | | -| build | `npm run build` | Build all modules | |
15 | | -| meta | `npm run meta` | Create esbuild meta for analysis | |
16 | | -| check | `npm run check` | Check for circular dependencies | |
17 | | -| lint | `npm run lint` | Run static code analysis | |
18 | | -| test | `npm run test` | Run unit tests and exit | |
19 | | -| test-watch | `npm run test-watch` | Watch for changes and re-run tests | |
20 | | -| test-coverage | `npm run test-coverage` | Generate a test coverage report | |
21 | | -| format | `npm run format` | Check source file formatting | |
22 | | -| format-fix | `npm run format-fix` | Format source files | |
23 | | - |
24 | 10 | ## Structure |
25 | 11 |
|
26 | 12 | This repository employs a [monorepo](https://en.wikipedia.org/wiki/Monorepo) setup which hosts a number of associated packages under the `packages` directory. They can be used in any combination and define minimum dependencies between each other. |
@@ -58,6 +44,20 @@ A convenience package is provided to make core packages available to your develo |
58 | 44 | | ------------- | ------------------------------------ | ----------- | |
59 | 45 | | `renderlayer` | [![NPM version][npm-badge]][npm-url] | bundle | |
60 | 46 |
|
| 47 | +## Scripts |
| 48 | + |
| 49 | +| Action | Command | Description | |
| 50 | +| ------------- | ----------------------- | ---------------------------------- | |
| 51 | +| build | `npm run build` | Build all modules | |
| 52 | +| meta | `npm run meta` | Create esbuild meta for analysis | |
| 53 | +| check | `npm run check` | Check for circular dependencies | |
| 54 | +| lint | `npm run lint` | Run static code analysis | |
| 55 | +| test | `npm run test` | Run unit tests and exit | |
| 56 | +| test-watch | `npm run test-watch` | Watch for changes and re-run tests | |
| 57 | +| test-coverage | `npm run test-coverage` | Generate a test coverage report | |
| 58 | +| format | `npm run format` | Check source file formatting | |
| 59 | +| format-fix | `npm run format-fix` | Format source files | |
| 60 | + |
61 | 61 | ## Tools |
62 | 62 |
|
63 | 63 | | Tool | Reference | |
|
0 commit comments