release: docs v0.6 (Orillusion#141)

ririkoa · May 7, 2023 · cc7c4f9 · cc7c4f9
2 parents 06b085d + e47e027
commit cc7c4f9
Show file tree

Hide file tree

Showing 573 changed files with 80,658 additions and 94 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,4 +1,4 @@
-name: CI auto test on push
+name: CI Test
 
 on:
   push:
@@ -8,7 +8,7 @@ on:
 
 jobs:
   test:
-    runs-on: macos-latest
+    runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
 
@@ -27,7 +27,7 @@ jobs:
       run: pnpm install
 
     - name: Test Build
-      run: pnpm run build
+      run: pnpm run build:test
 
     - name: Test in Electron
       run: pnpm run test:ci

diff --git a/.gitignore b/.gitignore
@@ -8,7 +8,7 @@ yarn.lock
 package-lock.json
 
 # production
-/dist
+dist
 /docs
 
 # misc
@@ -21,3 +21,5 @@ package-lock.json
 /.env
 /.env.local
 /js
+
+/.vscode
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "public"]
+	path = public
+	url = [email protected]:orillusion/assets.git
diff --git a/README.md b/README.md
@@ -1,12 +1,9 @@
-
 ![Cover Art](https://github.com/Orillusion/orillusion-webgpu-samples/blob/main/logo_new.png)     
-
-> **Note:**
-> 
-> Currently, this repo is used to collect feedback on the NPM package of the Orillusion engine. According to all the feedback, we will carry on refining the engine core. Then, we need to set up the regulations for a long-term open source project and all the source code will be put in this repo in the near future, which indicates a brand new journey for Orillusion.      
-  
-
 ## Orillusion
+
+[![Test](https://github.com/Orillusion/orillusion/actions/workflows/ci.yml/badge.svg)](https://github.com/Orillusion/orillusion/actions/workflows/ci.yml)
+[![npm](https://img.shields.io/npm/v/@orillusion/core)](https://www.npmjs.com/package/@orillusion/core)
+
 `Orillusion`  is a pure Web3D rendering engine which is fully developed based on the `WebGPU` standard. It aims to achieve desktop-level rendering effects and supports 3D rendering of complex scenes in the browser.
 
 ## Need to know
@@ -42,7 +39,7 @@ In order to use the engine more conveniently, we support to use native `<script>
 ```
 The above link loads the global build of `Orillusion`, where all top-level APIs are exposed as properties on the global `Orillusion` object.
 
--  **ESModule Build:** We recommend using the [ESModule](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Guide/Modules) way for development. As most browsers have supported `ES` module, we just need to import the `ES` build version of `orillusion.es.js`
+-  **ESModule Build:** We recommend using the [ESModule](https://developer.mozilla.org/docs/Web/JavaScript/Guide/Modules) way for development. As most browsers have supported `ES` module, we just need to import the `ES` build version of `orillusion.es.js`
 ```html
 <script type="module">  
     import { Engine3D, Camera3D } from "https://unpkg.com/@orillusion/core/dist/orillusion.es.js" 
@@ -100,13 +97,12 @@ await Engine3D.init({
     canvasConfig: { canvas }  
 })
 ```
+Please read the [Docs](https://www.orillusion.com/guide/) to Learn More.
 
 ## Platform
 **Chrome Canary: 113+**  
 **Edge Canary: 113+**
 
-> *As WebGPU is not released, please enable `chrome://flags/#enable-unsafe-webgpu` or `edge://flags/#enable-unsafe-webgpu`*
-
 ## Useful links
 - [Official Web Site](https://www.orillusion.com/)
 - [Documentation](https://www.orillusion.com/guide/)

diff --git a/index.html b/index.html
@@ -72,7 +72,7 @@
 </head>
 
 <body>
-    <script type="module" src="/src/sample/index.ts"></script>
+    <script type="module" src="/samples/index.ts"></script>
 </body>
 
 </html>
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@orillusion/core",
-    "version": "0.5.0",
+    "version": "0.6.0",
     "author": "Orillusion",
     "description": "Orillusion WebGPU Engine",
     "main": "./dist/orillusion.umd.js",
@@ -20,17 +20,18 @@
     "scripts": {
         "dev": "vite",
         "build": "tsc --p tsconfig.build.json && vite build && npm run build:types && npm run minify:es",
+        "build:test": "tsc --p tsconfig.build.json && vite build",
         "build:types": "tsc --emitDeclarationOnly -p tsconfig.build.json",
         "minify:es": "uglifyjs dist/orillusion.es.js -o dist/orillusion.es.js -c -m",
         "test": "electron test/ci/main.js",
-        "test:ci": "xvfb-maybe -- electron test/ci/main.js",
-        "test:install": "pnpm i electron@npm:electron-nightly@latest xvfb-maybe -O",
-        "docs": "npm run docs:core && npm run docs:physics && npm run docs:media",
+        "test:ci": "xvfb-maybe -- electron --enable-unsafe-webgpu --enable-features=Vulkan --use-vulkan=swiftshader --use-webgpu-adapter=swiftshader --no-sandbox test/ci/main.js",
+        "docs": "npm run docs:core && npm run docs:physics && npm run docs:media && npm run docs:stats",
         "docs:typedoc": "npx typedoc --plugin typedoc-plugin-markdown --plugin ./script/typedoc-plugin-not-exported.js --tsconfig tsconfig.build.json --gitRevision main --hideBreadcrumbs true --allReflectionsHaveOwnDocument true --readme none --excludeInternal --excludePrivate --excludeProtected --sort source-order --out",
         "docs:core": "npm run docs:typedoc docs/api src/index.ts",
-        "docs:physics": "npm run docs:typedoc docs/physics src/libs/physics/index.ts",
-        "docs:media": "npm run docs:typedoc docs/media-extention src/libs/media-extention/index.ts",
-        "docs:stats": "npm run docs:typedoc docs/stats src/libs/stats/index.ts"
+        "docs:physics": "cd packages/physics && npm run docs",
+        "docs:media": "cd packages/media-extention && npm run docs",
+        "docs:stats": "cd packages/stats && npm run docs",
+        "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s"
     },
     "devDependencies": {
         "@webgpu/types": "^0.1.30",
@@ -40,7 +41,8 @@
         "vite": "^4.2.2"
     },
     "optionalDependencies": {
-        "electron": "npm:electron-nightly@latest",
+        "conventional-changelog-cli": "^2.2.2",
+        "electron": "25.0.0-beta.1",
         "uglify-js": "^3.17.4",
         "xvfb-maybe": "^0.2.1"
     }
-Original file line number
+Diff line change
@@ Expand Up / @@ -72,7 +72,7 @@ @@
     </head>
     <body>
-        <script type="module" src="/src/sample/index.ts"></script>
+        <script type="module" src="/samples/index.ts"></script>
     </body>
     </html>