From 9a44550e2ed5b9fbe9a2094a5aede599f03851c8 Mon Sep 17 00:00:00 2001
From: cast1e <rooger233@gmail.com>
Date: Thu, 17 Oct 2024 22:47:05 +0800
Subject: [PATCH] Add README

---
 README.md              | 46 ++++++++++++++++++++++++++++++++++++++++++
 wallitor-gui/README.md | 39 -----------------------------------
 2 files changed, 46 insertions(+), 39 deletions(-)
 create mode 100644 README.md
 delete mode 100644 wallitor-gui/README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0b0eb6e
--- /dev/null
+++ b/README.md
@@ -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.
diff --git a/wallitor-gui/README.md b/wallitor-gui/README.md
deleted file mode 100644
index cabc9d5..0000000
--- a/wallitor-gui/README.md
+++ /dev/null
@@ -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
-```