Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jwenjian committed Jun 27, 2020
1 parent 8e7182e commit d9f9b0e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Expand Up @@ -4,6 +4,10 @@

LuckyYou is a simple app build on [tauri](https://github.com/tauri-apps/tauri) framework to provide a crossplatform application to do a lucky draw or make a roll call on your class or similar use cases.

## Screenshots

![截屏2020-06-27 下午5.20.17.png](https://i.loli.net/2020/06/27/gyBWUFu1kCqQwEV.png)

## Install

Firstly you need to download from release page according to your platform, I will always release 3 files per version:
Expand Down Expand Up @@ -41,6 +45,13 @@ Click this button can toggle between mute / unmute status, if the status is mute

We support 2 languages for now, you can click this button to switch to your language

## Note

1. This app is not support update directly for now, so if you have an old version, please unintall it before you install a new version

2. Your image file better be small(like less than 1Mb),otherwise it will consume more memory

3. Your image file name better be short(like less than 10 words), otherwise it may be wrapped and replaced with `...`

## License

Expand Down
12 changes: 12 additions & 0 deletions README_cn.md
Expand Up @@ -2,6 +2,10 @@

LuckyYou 是一个基于 [tauri](https://github.com/tauri-apps/tauri) 框架开发的跨平台软件,你可以用它来做抽奖活动或者课堂点名或者其他类似的使用场景中。

## 截图

![截屏2020-06-27 下午5.20.25.png](https://i.loli.net/2020/06/27/PYe9TEScaAwu61m.png)

## 安装

首先你需要根据你使用的系统去 release 页面下载对应的安装包,每个版本都会有 3 个文件:
Expand Down Expand Up @@ -38,6 +42,14 @@ LuckyYou 是一个基于 [tauri](https://github.com/tauri-apps/tauri) 框架开

当前软件支持两种语言,中文 / 英文,你可以点击这个按钮切换至你想要的语言

## 注意

1. 目前该软件还不支持直接更新,如果你已经安装了老版本,请先卸载老版本,再安装新版本

2. 你的图片文件不宜过大(比如超过1Mb),否则会占用比较多内存

3. 你的图片文件名不宜过长,否则可能会展示不全,以 10 字以内为宜

## 开源协议

CC0-1.0, 署名,非商业。

0 comments on commit d9f9b0e

Please sign in to comment.