Add README

master
cast1e 2024-10-17 22:47:05 +08:00
parent 916389ca55
commit 9a44550e2e
2 changed files with 46 additions and 39 deletions

46
README.md 100644
View File

@ -0,0 +1,46 @@
# Wallitor
A dynamic wallpaper software build with tauri.
## Setup
This project has two parts, core and GUI.
### Core
Build solution with *MSVC*, you'll get a dynamic library.
### GUI
GUI is build with *tauri* and *vite+vue*, using *pnpm* as package manager.
1. Install node packages.
```
pnpm install
```
2. Build project
```
pnpm tauri build
```
### Combination
Copy libracy and place in the same directory with executable file.
## Releases
See [Release](https://github.com/RogerChen2005/wallitor/releases)
## Contributions
Welcome Issues and PRs!
## Acknowledgement
Wallitor was based on these projects:
* [tauri-apps/tauri](https://github.com/tauri-apps/tauri): Build smaller, faster, and more secure desktop applications with a web frontend.
* [vitejs/vite](https://github.com/vitejs/vite): Next generation frontend tooling. It's fast!
* [vuejs/vue](https://github.com/vuejs/vue): Vue is a **progressive framework** for building user interfaces.

View File

@ -1,39 +0,0 @@
# wallitor-gui
This template should help get you started developing with Vue 3 in Vite.
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
## Type Support for `.vue` Imports in TS
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
## Customize configuration
See [Vite Configuration Reference](https://vitejs.dev/config/).
## Project Setup
```sh
pnpm install
```
### Compile and Hot-Reload for Development
```sh
pnpm dev
```
### Type-Check, Compile and Minify for Production
```sh
pnpm build
```
### Lint with [ESLint](https://eslint.org/)
```sh
pnpm lint
```