|
1 | | -<div style="display: flex, margin: 8px"> |
| 1 | +<div style="display: flex"> |
2 | 2 | <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"/> |
9 | 3 | </div> |
10 | 4 |
|
11 | 5 | [中文文档](./README.zh-CN.md) |
12 | 6 |
|
13 | 7 | ### 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. |
15 | 9 |
|
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 |
18 | 14 |
|
19 | 15 | ### 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` |
31 | 17 | - Run `make desktop-debug` to run it on desktop platform |
32 | 18 | - 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 |
35 | 19 | - Refer to [Makefile](./Makefile) for more information |
36 | 20 |
|
37 | | -### Android platform build information |
38 | | -- `min-sdk-version = 23` |
39 | | -- `target-sdk-version = 32` |
40 | | - |
41 | 21 | ### Troubleshooting |
42 | 22 | - 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. |
43 | 24 |
|
44 | 25 | ### Reference |
45 | 26 | - [Slint Language Documentation](https://slint-ui.com/releases/1.0.0/docs/slint/) |
|
0 commit comments