feat: Update Readme and docs

Author: Intro1997

.vscode/c_cpp_properties.json

@@ -5,7 +5,7 @@
       "includePath": [
         "/Users/intro/Library/Android/sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/darwin-x86_64/sysroot/**",
         "${workspaceFolder}/**",
-        "${workspaceFolder}/app/dependency/cpp/node/include",
+        "${workspaceFolder}/app/dependency/cpp/node/include"
       ],
       "macFrameworkPath": [
         "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks"

README.md

@@ -1,3 +1,6 @@
+![C++17](https://img.shields.io/badge/C%2B%2B-17-blue.svg)
+![NodeJS v14.17.0](https://img.shields.io/badge/NodeJS-v14.17.0-blue.svg)
+
 # Description
 
 This project aims to run Web Audio API in Android with javascript code. Most of the available APIs have passed wpt test cases.
@@ -22,18 +25,32 @@ Now it supports following Web Audio feature:
 
 more detail info is descript [here](./js_api_define/features.md).
 
-# Run
+# Build & Run
 
 1. run `npm install` for installing dependency
 2. run `npm start` to get server address like `http://xxx.xxx.xxx.xxx:20490`
-3. add this line `js_entry="http://xxx.xxx.xxx.xxx:20490/index.js"` to local.property file
+3. open root folder with Android Studio
+4. add this line `js_entry="http://xxx.xxx.xxx.xxx:20490/index.js"` to local.property file
+5. build and run app
 
-# Develop
+# App Interface
+
+After running app, you can see five buttons:
 
-## VSCode
+1. `START`: Start running js code in `index.js`
+2. `STOP`: Stop js event loop. You need to press `RESTART` button to re-run js code.
+3. `PAUSE`: Pause js event loop.
+4. `RESUME`: Resume js event from pause.
+5. `RESTART`: Restart app.
+
+NOTE: all console message in js code will be output to Android Studio Logcat.
+
+# Develop
 
-1. You should open root folder by vscode after running app or building app at `app/build.gradle.kts` page. This will make Android Studio generate `.vscode/compile_commands.json` file, which is used by vscode to recognize cpp headers.
+see [develop.md](./docs/develop.md)
 
-# Note:
+# Thanks
 
-1. `combine` script in package.json is used to make vscode recognize all cpp files in different module inside android module. When Android Build success, scripts in `build.gradle.kts` will move all `compile_commands.json` contents to `.vscode/compile_commands.json`, this will make vscode cpp intelligence works fine.
+1. Test case based on [wpt](https://github.com/web-platform-tests/wpt).
+2. NAPI_IH base on [node-addon-api-helper](https://github.com/ajihyf/node-addon-api-helper).
+3. Use [ProcessPhoenix](https://github.com/JakeWharton/ProcessPhoenix) to restart Android App.

docs/develop.md

@@ -0,0 +1,35 @@
+# Develop
+
+## package.json
+
+We put some useful script in `package.json` file:
+
+```json
+"scripts": {
+    "compress": "node js_task/compress.js",
+    "combine": "node js_task/combine_compile_commands.js",
+    "valid": "ROOT_DIR=$(pwd) node ./js_task/valid_task/valid.js",
+    "start": "npm run compress && http-server -p 20490"
+  },
+```
+
+1. `compress`: each NAPI module which needs to be exported in js is export by `globalThis.ModuleApiName = process._linkedBinding("ModuleName").ApiName;`. These js code are put in `**/preload_script.js` file, which will be converted to c string saved in `**/preload_script.hpp`. This process is handled by `compress` command.
+2. `combine`: cpp code of this project is developed in vscode, so we need to add all relative file paths to the `compileCommands` options of `.vscode/c_cpp_properties.json`. These cpp relative files will be created when do build in Android Studio, `combine` command is used to collect and add them to `.vscode/compile_commands.json`, then vscode can recognize cpp symbol.
+3. `valid`: Use to check if WaveProducer, a tool used in OscillatorNode, works correctly.
+4. `start`: do `compress` and start a http-server accessed by app to load js code which need to be run.
+
+## cpp hint
+
+If you write cpp layer in vscode, you should build once after Android Studio sync. Build will trigger `combine` command which makes vscode recognize cpp symbol.
+
+NOTE: if you find vscode not recognize cpp symbol, make sure to switch the Android Studio tab to `app/build.gradle.kts`, then build.
+
+## NAPI
+
+### NodeJS
+
+The node env of this project is based on [v14.17.0](https://github.com/toyobayashi/node-android-build/releases/tag/v14.17.0) of [node-android-build](https://github.com/toyobayashi/node-android-build). The build tutorial is referenced to [在 Android 应用中嵌入 Node.js](https://toyobayashi.github.io/2021/03/29/NodeEmbedding/)
+
+### NAPI_IH
+
+The goal of the project architecture is to make the structure of the napi layer consistent with the cpp layer. But NAPI do not support inheritance, so we make a pitch to NAPI, that is [NAPI_IH](./napi_ih_api.md).

…dency/cpp/node/include/napi_ih/README.md docs/napi_ih_api.mdapp/dependency/cpp/node/include/napi_ih/README.md renamed to docs/napi_ih_api.md app/dependency/cpp/node/include/napi_ih/README.md renamed to docs/napi_ih_api.md

@@ -1,4 +1,4 @@
-# Description
+# NAPI_IH
 
 `napi_ih` means "napi inheritance helper" which is a pitch to napi to support inheritance and try to keep the style of napi. The implementation is inspired by https://github.com/ajihyf/node-addon-api-helper and https://mmomtchev.medium.com/-class-inheritance-with-node-api-and-node-addon-api-c180334d9902
 

package.json

@@ -4,7 +4,6 @@
   "description": "",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
     "compress": "node js_task/compress.js",
     "combine": "node js_task/combine_compile_commands.js",
     "valid": "ROOT_DIR=$(pwd) node ./js_task/valid_task/valid.js",