@galacean/engine-shaderlab 0.0.0-experimental-1.4-small-language.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2020 - present Ant Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+## Installation
+
+```sh
+npm install @galacean/engine-shaderlab
+```
+
+## Usage
+
+```typescript
+import { ShaderLab } from "@galacean/engine-shaderlab";
+
+// Create ShaderLab
+const shaderLab = new ShaderLab();
+
+// Create engine with shaderLab
+const engine = await WebGLEngine.create({ canvas: "canvas", shaderLab });
+
+......
+
+// Create shader by galacean shader code directly
+const shader = Shader.create(galaceanShaderCode);
+
+.......
+
+// Run engine
+engine.run()
+```
+
+There are two versions of ShaderLab: `Release` and `Verbose`. The `Verbose` version offers more user-friendly diagnostic information for debug ShaderLab compilation errors, while the Release version provides superior performance.
+
+you can use `Verbose` version by import:
+
+```ts
+import { ShaderLab } from "@galacean/engine-shaderlab/verbose";
+```
+
+## CFG Grammar conflict detection
+
+The Galacean ShaderLab syntax is defined using Context-Free Grammar (CFG) and is documented within the `\*.y` file. When modifications to the ShaderLab syntax are required, it is recommended to make changes to the existing CFG syntax file, and employ [Bison](https://www.gnu.org/software/bison/manual/bison.html) to detect any potential grammar conflicts.
+
+```sh
+bison ./Parser.y -r all
+```