Skip to content

Commit

Permalink
📝 docs: add README
Browse files Browse the repository at this point in the history
Signed-off-by: SimonShiki <[email protected]>
  • Loading branch information
SimonShiki committed Aug 11, 2024
1 parent 143f64e commit 396dcc9
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 4 deletions.
42 changes: 38 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,41 @@
# Tauri + React + Typescript
<br />

This template should help get you started developing with Tauri, React and Typescript in Vite.
### 项目仍处于早期开发阶段,测试版本遇到问题属于正常现象,欢迎提交 issue!
---

## Recommended IDE Setup
<div align='center'>
<img src='./images/logo.png' width='200' />
<h2>知音 Cicadas</h2>
<p>支持多音源的音乐播放器</p>
<p>
<a href='https://github.com/SimonShiki/cicadas/releases'>下载</a>
<br />
<img src='./images/screenshot-main.png' width='300' />
<img src='./images/screenshot-play.png' width='300' />
</p>
</div>

- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
## ✨ 特性

- 🕶️ Fluent Design - 播放器全套设计尽可能遵循 Fluent Design 标准
- 👌 基础功能 - 音乐库分类,搜索,基本播放控制,后台播放,Windows 媒体集成
- 🏠 本地音乐播放 - 多文件夹扫描 + 内嵌歌词读取
- 🎵 多音源支持 - 网易云歌单展示 + 搜索, ~~WebDAV 自动同步~~开发中
- 🪶 轻量 - 可执行文件不超过 5M
- 🦀 现代开发栈 - 前端使用 TypeScript, 播放后端使用 Rust

## ☂️ 运行需求

目前考虑了 Windows 11 的兼容性,后续可能会增加其他 Windows 版本或其它系统的支持

## 🍙 开发环境

> 本项目基于 [tauri v2](https://v2.tauri.app/) 构建,请先阅读 [Prerequisites](https://v2.tauri.app/start/prerequisites/)
```bash
git clone [email protected]:SimonShiki/cicadas.git
cd cicadas
yarn install # 或 npm install
yarn tauri dev # 开发服务器
yarn tauri build # 构建
```
Binary file added images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshot-main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshot-play.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 396dcc9

Please sign in to comment.