Skip to content

Commit 28849f0

Browse files
committed
[*] update normally
1 parent 98a1446 commit 28849f0

File tree

5 files changed

+18
-55
lines changed

5 files changed

+18
-55
lines changed

README.md

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,26 @@
1-
<div style="display: flex, margin: 8px">
1+
<div style="display: flex">
22
<img src="./screenshot/1-en.png" width="100"/>
3-
<img src="./screenshot/2-en.png" width="100"/>
4-
<img src="./screenshot/3-en.png" width="100"/>
5-
<img src="./screenshot/4-en.png" width="100"/>
6-
<img src="./screenshot/5-en.png" width="100"/>
7-
<img src="./screenshot/6-en.png" width="100"/>
8-
<img src="./screenshot/7-en.png" width="100"/>
93
</div>
104

115
[中文文档](./README.zh-CN.md)
126

137
### Introduction
14-
It's a Rust template project for Slint GUI. It cantains frequently-used components, setting panel, configure, simple database feature and other somall feature. This project can be compiled to Desktop (Windows, Linix, Macos), Android and Web platform.
8+
This is a screen recording tool for `Linux` `Wayland`, which uses the `wlroots` extension protocol to capture screenshots. Commonly used desktop environments include `Sway` and `Hyprland`. It is based on `Rust` and the `Slint` GUI framework.
159

16-
### How to initialize a new project?
17-
Enter the `script` directory and run `./init-project.sh <new-project-name>` to initialize a new project.
10+
### Features
11+
- Single screen recording
12+
- Single input device audio recording
13+
- Desktop audio recording
1814

1915
### How to build?
20-
- Install `Rust`, `Cargo`, `cargo-apk` and `wasm-pack`
21-
- Install Android `sdk`, `ndk`, `jdk17`, and set environment variables.
22-
- Example:
23-
```
24-
export JAVA_HOME=$LIBRARY_PATH/openjdk
25-
export ANDROID_HOME=$HOME/Android/Sdk
26-
export ANDROID_NDK=$HOME/Android/Sdk/ndk/27.0.12077973
27-
export ANDROID_NDK_ROOT=$HOME/Android/Sdk/ndk/27.0.12077973
28-
```
29-
30-
- Run `make android-build-release` to build a release version android APK
16+
- Install`Rust`, `Cargo`, `libpipewire` and `libalsa`
3117
- Run `make desktop-debug` to run it on desktop platform
3218
- Run `make desktop-build-release` to build a release version desktop application
33-
- Run `make web-build-dist` to build a release version website. And the output directory is `web/dist`
34-
- Run `make web-server-dist` to run a website server
3519
- Refer to [Makefile](./Makefile) for more information
3620

37-
### Android platform build information
38-
- `min-sdk-version = 23`
39-
- `target-sdk-version = 32`
40-
4121
### Troubleshooting
4222
- Using the `Qt backend` can resolve the issue of fuzzy fonts on the Windows platform. It is also recommended to prioritize the `Qt backend` to maintain a consistent build environment with the developers.
23+
- `ffmpeg` needs to be installed. It is used to combine the recorded video and audio into the final `MP4` file.
4324

4425
### Reference
4526
- [Slint Language Documentation](https://slint-ui.com/releases/1.0.0/docs/slint/)

README.zh-CN.md

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,26 @@
1-
<div style="display: flex, margin: 8px">
1+
<div style="display: flex">
22
<img src="./screenshot/1-cn.png" width="100"/>
3-
<img src="./screenshot/2-cn.png" width="100"/>
4-
<img src="./screenshot/3-cn.png" width="100"/>
5-
<img src="./screenshot/4-cn.png" width="100"/>
6-
<img src="./screenshot/5-cn.png" width="100"/>
7-
<img src="./screenshot/6-cn.png" width="100"/>
8-
<img src="./screenshot/7-cn.png" width="100"/>
93
</div>
104

115
[English Documentation](./README.md)
126

137
### 简介
14-
这是一个基于Rust和Slint GUI框架的模板项目。包含一些常用的组件,设置面板,配置文件,简单的数据库功能和其他小功能。这个项目的主要目的是给新手开发者提供一个简单快速的Slint GUI开发环境。该项目能够编译到桌面平台(Windows, Linux, Macos),Android移动平台和Web平台
8+
这是一个针对`Linux` `wayland`的录屏工具,使用`wlroots`扩展协议获取屏幕截图。常用的桌面环境:`sway``Hyprland`等。基于`Rust``Slint` GUI框架
159

16-
### 如何初始化新项目?
17-
进入`script`目录并运行`./init-project.sh <new-project-name> `来初始化一个新项目。
10+
### 功能
11+
- 单个屏幕录制
12+
- 单个输入设备录音
13+
- 桌面音频录制
1814

1915
### 如何构建?
20-
- 安装 `Rust``Cargo`
21-
- 安装 Android `sdk`, `ndk`, `jdk17`, 和设置对应的环境变量
22-
- 例子:
23-
```
24-
export JAVA_HOME=$LIBRARY_PATH/openjdk
25-
export ANDROID_HOME=$HOME/Android/Sdk
26-
export ANDROID_NDK=$HOME/Android/Sdk/ndk/27.0.12077973
27-
export ANDROID_NDK_ROOT=$HOME/Android/Sdk/ndk/27.0.12077973
28-
```
29-
30-
- 运行 `make android-build-release` 编译安卓平台程序
16+
- 安装 `Rust`, `Cargo`, `libpipewire``libalsa`
3117
- 运行 `make desktop-debug` 调试桌面平台程序
3218
- 运行 `make desktop-build-release` 编译桌面平台程序
33-
- 运行 `make web-build-dist` 编译Web平台。构建输出目录`web/dist`
3419
- 参考 [Makefile](./Makefile) 了解更多信息
3520

36-
### 安卓平台编译信息
37-
- `min-sdk-version = 23`
38-
- `target-sdk-version = 32`
39-
4021
### 问题排查
4122
- 使用`Qt后端`能解决windows平台字体发虚的问题。也推荐优先使用`Qt后端`保持和开发者相同的构建环境
23+
- 需要安装`ffmpeg`。用于将录制的视频和音频合成最后的`MP4`文件
4224

4325
### 参考
4426
- [Slint Language Documentation](https://slint-ui.com/releases/1.0.0/docs/slint/)

package/deb/package/DEBIAN/control

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Depends:
66
Section: utils
77
Priority: optional
88
Homepage: https://github.com/heng30/wayshot
9-
Description: Rust Slint GUI template project(Rust Slint GUI 模板项目)
9+
Description: 这是一个针对`Linux` `wayland`的录屏工具,使用`wlroots`扩展协议获取屏幕截图。(This is a screen recording tool for `Linux` `Wayland`, which uses the `wlroots` extension protocol to capture screenshots.)

package/deb/package/usr/share/applications/wayshot.desktop

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ Type=Application
77
Categories=Utility;Development;
88
StartupNotify=true
99
StartupWMClass=wayshot
10-
Comment=Description: Rust Slint GUI template project(Rust Slint GUI 模板项目)
10+
Comment=Description: 这是一个针对`Linux` `wayland`的录屏工具,使用`wlroots`扩展协议获取屏幕截图。(This is a screen recording tool for `Linux` `Wayland`, which uses the `wlroots` extension protocol to capture screenshots.)

wayshot/ui/images/png/brand.png

253 KB
Loading

0 commit comments

Comments
 (0)