docs: added README.md

Author: morlay

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 innoai.tech
+
+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.

README.md

@@ -0,0 +1,41 @@
+# VueKit
+
+## Code Structure
+
+```
+nodepkg/                        # monorepo 子 package, z
+    <lib>/
+        src/
+        package.json
+
+webapp/<APP_NAME>/
+    mod/                        # 业务模块
+        auth/
+        account/
+    layout/  
+    client/                                           
+    page/                       # File System Routing
+        accounts/
+            [id].tsx
+            index.tsx
+        accounts.tsx            # 作为 /accounts/* 的 Wrap
+        about.tsx   
+        index.tsx
+        [...all].tsx            # 其他
+```
+
+## Misc
+
+### File System Routing
+
+虽然该功能是由 [vite-plugin-pages](https://github.com/hannoeru/vite-plugin-pages) 提供，
+但由于 meta 纯 yaml 配置，灵活性较差，这里利用 TypeScript JSDoc 的功能，直接将 meta 信息绑定到 `route.component` 上。
+定义如下：
+
+```tsx
+/**
+ * @property {"管理员"} meta.name
+ * @property {typeof import("@mdi/js").mdiAccountSupervisor} meta.icon
+ */
+export default component(/*...*/);
+```