docs(update): 更新文档,添加 LICENSE

This commit is contained in:
BTMuli
2023-03-05 14:53:17 +08:00
parent 0b922f2aeb
commit b07bcabd0e
4 changed files with 67 additions and 10 deletions

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (C) 2023-present BTMuli<bt-muli@outlook.com>
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.

View File

@@ -1,16 +1,32 @@
# Tauri + Vue 3 + TypeScript ---
Author: 目棃
Date: 2023-03-05
Description: 说明文档
Update: 2023-03-05
---
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more. > 本文档 [`Front-matter`](https://github.com/BTMuli/Mucli#FrontMatter) 由 [MuCli](https://github.com/BTMuli/Mucli) 自动生成于`2023-03-05 14:41:55`
>
> 更新于 `2023-03-05 14:41:55`
## Recommended IDE Setup # Tauri.Genshin
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) Tauri 练手项目
## Type Support For `.vue` Imports in TS ## 技术栈
Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps: - [Tauri](https://tauri.studio/zh-CN/)
- [Vue3](https://v3.cn.vuejs.org/)
- [Vite](https://cn.vitejs.dev/)
- [TypeScript](https://www.typescriptlang.org/)
- [Naive UI](https://www.naiveui.com/zh-CN/os-theme/dark)
1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled. ## 开发
2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.
You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471). ```bash
npm run tauri dev
```
# License
[MIT](LICENSE)

1
package-lock.json generated
View File

@@ -7,6 +7,7 @@
"": { "": {
"name": "tauri-genshin", "name": "tauri-genshin",
"version": "0.0.0", "version": "0.0.0",
"license": "MIT",
"dependencies": { "dependencies": {
"@tauri-apps/api": "^1.2.0", "@tauri-apps/api": "^1.2.0",
"vue": "^3.2.45" "vue": "^3.2.45"

View File

@@ -1,14 +1,33 @@
{ {
"name": "tauri-genshin", "name": "tauri-genshin",
"description": "A Tauri App Demo",
"private": true, "private": true,
"version": "0.0.0", "version": "0.0.0",
"type": "module",
"scripts": { "scripts": {
"dev": "vite", "dev": "vite",
"build": "vue-tsc --noEmit && vite build", "build": "vue-tsc --noEmit && vite build",
"preview": "vite preview", "preview": "vite preview",
"tauri": "tauri" "tauri": "tauri"
}, },
"directories": {
"doc": "docs"
},
"repository": {
"type": "git",
"url": "git+https://github.com/BTMuli/Tauri.Genshin.git"
},
"keywords": [
"Tauri",
"Node",
"Typescript",
"Vite"
],
"author": "BTMuli <bt-muli@outlook.com>",
"license": "MIT",
"bugs": {
"url": "https://github.com/BTMuli/Tauri.Genshin/issues"
},
"homepage": "https://github.com/BTMuli/Tauri.Genshin#readme",
"dependencies": { "dependencies": {
"vue": "^3.2.45", "vue": "^3.2.45",
"@tauri-apps/api": "^1.2.0" "@tauri-apps/api": "^1.2.0"